UDPPacket (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.router.transport.udp.UDPPacket

All Implemented Interfaces:
CDPQEntry, CDQEntry, PQEntry
```
class UDPPacket
extends Object
implements CDPQEntry
```
UDP datagram wrapper implementing CDPQEntry for priority queue dispatch.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`IV_SIZE` Size of initialization vector in bytes.
`static int`	`MAC_SIZE` Size of MAC (Message Authentication Code) in bytes.
`(package private) static int`	`MAX_PACKET_SIZE` Maximum SSU packet size in bytes.
`static int`	`MAX_PAYLOAD_TYPE` Largest payload type value.
`static int`	`PAYLOAD_TYPE_DATA` Packet type: data.
`static int`	`PAYLOAD_TYPE_RELAY_INTRO` Packet type: relay intro.
`static int`	`PAYLOAD_TYPE_RELAY_REQUEST` Packet type: relay request.
`static int`	`PAYLOAD_TYPE_RELAY_RESPONSE` Packet type: relay response.
`static int`	`PAYLOAD_TYPE_SESSION_CONFIRMED` Packet type: session confirmed.
`static int`	`PAYLOAD_TYPE_SESSION_CREATED` Packet type: session created.
`static int`	`PAYLOAD_TYPE_SESSION_DESTROY` Packet type: session destroy.
`static int`	`PAYLOAD_TYPE_SESSION_REQUEST` Packet type: session request.
`static int`	`PAYLOAD_TYPE_TEST` Packet type: test.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UDPPacket`	`acquire(RouterContext ctx, boolean inbound)` Inbound flag.
`static void`	`clearCache()` Clear cache.
`void`	`drop()` Discard the packet and release it back to the cache.
`FIFOBandwidthLimiter.Request`	`getBandwidthRequest()` Bandwidth request.
`long`	`getBegin()` Initialization time.
`long`	`getEnqueueTime()` Enqueue time.
`(package private) int`	`getFragmentCount()` Fragment count
`long`	`getLifetime()` Packet lifetime.
`int`	`getMarkedType()` Marked type.
`(package private) int`	`getMessageType()` Message type
`DatagramPacket`	`getPacket()` Underlying packet.
`int`	`getPriority()` Send priority.
`(package private) RemoteHostId`	`getRemoteHost()` Lazily obtains the `RemoteHostId` representing the sender's address and port.
`long`	`getSeqNum()` Packet sequence number.
`(package private) long`	`getTimeSinceReceived()` Returns the amount of time elapsed since the packet was received.
`void`	`markType(int type)` Mark type.
`static String`	`payloadTypeToString(int type)` Packet type enumeration.
`(package private) void`	`received()` Marks the packet as received, recording the current time.
`static void`	`reduceCacheSize()` Reduce cache size.
`void`	`release()` Return the packet to the object pool for reuse.
`void`	`requestOutboundBandwidth()` Request outbound bandwidth.
`void`	`resetBegin()` Reset initialization time.
`void`	`setEnqueueTime(long now)` Enqueue timestamp.
`(package private) void`	`setFragmentCount(int count)` Fragment count
`(package private) void`	`setMessageType(int type)` Message type
`void`	`setPriority(int pri)` Priority level.
`void`	`setSeqNum(long num)` Packet sequence number.
`String`	`toString()` Returns a detailed string representation of this packet, including address, size, priority, message and mark types, fragment counts, and timing information.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - IV_SIZE
```
public static final int IV_SIZE
```
    Size of initialization vector in bytes.
    See Also:
    Constant Field Values
  - MAC_SIZE
```
public static final int MAC_SIZE
```
    Size of MAC (Message Authentication Code) in bytes.
    See Also:
    Constant Field Values
  - MAX_PACKET_SIZE
```
static final int MAX_PACKET_SIZE
```
    Maximum SSU packet size in bytes.
    See Also:
    Constant Field Values
  - MAX_PAYLOAD_TYPE
```
public static final int MAX_PAYLOAD_TYPE
```
    Largest payload type value.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_DATA
```
public static final int PAYLOAD_TYPE_DATA
```
    Packet type: data.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_RELAY_INTRO
```
public static final int PAYLOAD_TYPE_RELAY_INTRO
```
    Packet type: relay intro.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_RELAY_REQUEST
```
public static final int PAYLOAD_TYPE_RELAY_REQUEST
```
    Packet type: relay request.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_RELAY_RESPONSE
```
public static final int PAYLOAD_TYPE_RELAY_RESPONSE
```
    Packet type: relay response.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_SESSION_CONFIRMED
```
public static final int PAYLOAD_TYPE_SESSION_CONFIRMED
```
    Packet type: session confirmed.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_SESSION_CREATED
```
public static final int PAYLOAD_TYPE_SESSION_CREATED
```
    Packet type: session created.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_SESSION_DESTROY
```
public static final int PAYLOAD_TYPE_SESSION_DESTROY
```
    Packet type: session destroy.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_SESSION_REQUEST
```
public static final int PAYLOAD_TYPE_SESSION_REQUEST
```
    Packet type: session request.
    See Also:
    Constant Field Values
  - PAYLOAD_TYPE_TEST
```
public static final int PAYLOAD_TYPE_TEST
```
    Packet type: test.
    See Also:
    Constant Field Values
- Method Detail
  - acquire
```
public static UDPPacket acquire(RouterContext ctx,
                                boolean inbound)
```
    Inbound flag.
  - clearCache
```
public static void clearCache()
```
    Clear cache.
  - drop
```
public void drop()
```
    Discard the packet and release it back to the cache.
    Specified by:
    drop in interface CDQEntry
  - getBandwidthRequest
```
public FIFOBandwidthLimiter.Request getBandwidthRequest()
```
    Bandwidth request.
  - getBegin
```
public long getBegin()
```
    Initialization time.
  - getEnqueueTime
```
public long getEnqueueTime()
```
    Enqueue time.
    Specified by:
    getEnqueueTime in interface CDQEntry
    Returns:
    the enqueue timestamp
  - getFragmentCount
```
int getFragmentCount()
```
    Fragment count
  - getLifetime
```
public long getLifetime()
```
    Packet lifetime.
  - getMarkedType
```
public int getMarkedType()
```
    Marked type.
  - getMessageType
```
int getMessageType()
```
    Message type
  - getPacket
```
public DatagramPacket getPacket()
```
    Underlying packet.
  - getPriority
```
public int getPriority()
```
    Send priority.
    Specified by:
    getPriority in interface PQEntry
    Returns:
    the priority value
  - getRemoteHost
```
RemoteHostId getRemoteHost()
```
    Lazily obtains the RemoteHostId representing the sender's address and port. This is initialized once per packet and cached thereafter.
    Returns:
    remote host identifier or null if address unavailable
  - getSeqNum
```
public long getSeqNum()
```
    Packet sequence number.
    Specified by:
    getSeqNum in interface PQEntry
    Returns:
    sequence number
  - getTimeSinceReceived
```
long getTimeSinceReceived()
```
    Returns the amount of time elapsed since the packet was received.
    Returns:
    milliseconds since received, or 0 if never received
  - markType
```
public void markType(int type)
```
    Mark type.
  - payloadTypeToString
```
public static String payloadTypeToString(int type)
```
    Packet type enumeration.
  - received
```
void received()
```
    Marks the packet as received, recording the current time.
  - reduceCacheSize
```
public static void reduceCacheSize()
```
    Reduce cache size.
  - release
```
public void release()
```
    Return the packet to the object pool for reuse.
  - requestOutboundBandwidth
```
public void requestOutboundBandwidth()
```
    Request outbound bandwidth.
  - resetBegin
```
public void resetBegin()
```
    Reset initialization time.
  - setEnqueueTime
```
public void setEnqueueTime(long now)
```
    Enqueue timestamp.
    Specified by:
    setEnqueueTime in interface CDQEntry
    Parameters:
    now - the enqueue timestamp
  - setFragmentCount
```
void setFragmentCount(int count)
```
    Fragment count
  - setMessageType
```
void setMessageType(int type)
```
    Message type
  - setPriority
```
public void setPriority(int pri)
```
    Priority level.
  - setSeqNum
```
public void setSeqNum(long num)
```
    Packet sequence number.
    Specified by:
    setSeqNum in interface PQEntry
    Parameters:
    num - sequence number to set
  - toString
```
public String toString()
```
    Returns a detailed string representation of this packet, including address, size, priority, message and mark types, fragment counts, and timing information. For logging and debugging purposes.
    Overrides:
    toString in class Object

Class UDPPacket

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IV_SIZE

MAC_SIZE

MAX_PACKET_SIZE

MAX_PAYLOAD_TYPE

PAYLOAD_TYPE_DATA

PAYLOAD_TYPE_RELAY_INTRO

PAYLOAD_TYPE_RELAY_REQUEST

PAYLOAD_TYPE_RELAY_RESPONSE

PAYLOAD_TYPE_SESSION_CONFIRMED

PAYLOAD_TYPE_SESSION_CREATED

PAYLOAD_TYPE_SESSION_DESTROY

PAYLOAD_TYPE_SESSION_REQUEST

PAYLOAD_TYPE_TEST

Method Detail

acquire

clearCache

drop

getBandwidthRequest

getBegin

getEnqueueTime

getFragmentCount

getLifetime

getMarkedType

getMessageType

getPacket

getPriority

getRemoteHost

getSeqNum

getTimeSinceReceived

markType

payloadTypeToString

received

reduceCacheSize

release

requestOutboundBandwidth

resetBegin

setEnqueueTime

setFragmentCount

setMessageType

setPriority

setSeqNum

toString