OutNetMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.OutNetMessage

All Implemented Interfaces:
CDPQEntry, CDQEntry, PQEntry
```
public class OutNetMessage
extends Object
implements CDPQEntry
```
Wrap up an outbound I2NP message, along with the information associated with its delivery and jobs to be fired off if particular events occur.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PRIORITY_BUILD_REPLY` Build reply priority
`static int`	`PRIORITY_EXPLORATORY` Exploratory priority
`static int`	`PRIORITY_HIGHEST` Highest priority
`static int`	`PRIORITY_HIS_BUILD_REQUEST` His build request priority
`static int`	`PRIORITY_HIS_NETDB_STORE` His netdb store priority
`static int`	`PRIORITY_LOWEST` Priorities, higher is higher priority.
`static int`	`PRIORITY_MEDIUM` Medium priority
`static int`	`PRIORITY_MY_BUILD_REQUEST` My build request priority
`static int`	`PRIORITY_MY_DATA` My data priority
`static int`	`PRIORITY_MY_NETDB_LOOKUP` My netdb lookup priority
`static int`	`PRIORITY_MY_NETDB_STORE` My netdb store priority
`static int`	`PRIORITY_MY_NETDB_STORE_LOW` My netdb store low priority
`static int`	`PRIORITY_NETDB_EXPLORE` Netdb explore priority
`static int`	`PRIORITY_NETDB_FLOOD` Netdb flood priority
`static int`	`PRIORITY_NETDB_HARVEST` Netdb harvest priority
`static int`	`PRIORITY_NETDB_REPLY` Netdb reply priority
`static int`	`PRIORITY_PARTICIPATING` Participating priority

Constructor Summary

Constructors
Constructor and Description
`OutNetMessage(RouterContext context)` Null msg and target, zero expiration (used in OutboundMessageRegistry only)
`OutNetMessage(RouterContext context, I2NPMessage msg, long expiration, int priority, RouterInfo target)` Standard constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginSend()` begin the send
`void`	`discardData()` We've done what we need to do with the data from this message, though we may keep the object around for a while to use its ID, jobs, etc.
`void`	`drop()` For CDQ
`long`	`getCreated()`
`long`	`getEnqueueTime()` For CDQ
`long`	`getExpiration()` Specify the # ms since the epoch after which if the message has not been sent the OnFailedSend job should be fired and the message should be removed from the pool.
`int`	`getFailedTransportCount()`
`List<String>`	`getFailedTransports()` As of 0.9.55, changed from a Set to a List
`long`	`getLifetime()`
`I2NPMessage`	`getMessage()` Specifies the message to be sent.
`int`	`getMessageData(byte[] outBuffer)` Copies the message data to outbuffer.
`long`	`getMessageId()`
`int`	`getMessageSize()` How large the message is, including the full 16 byte header.
`String`	`getMessageType()` For debugging only.
`int`	`getMessageTypeId()`
`Job`	`getOnFailedReplyJob()` If the Message selector is specified but it doesn't find a reply before its expiration passes, this job is enqueued.
`Job`	`getOnFailedSendJob()` If the router could not be reached or the expiration passed, this job is enqueued.
`ReplyJob`	`getOnReplyJob()` If the MessageSelector detects a reply, this job is enqueued
`Job`	`getOnSendJob()` After the message is successfully passed to the router specified, the given job is enqueued.
`int`	`getPriority()` Specify the priority of the message, where higher numbers are higher priority.
`MessageSelector`	`getReplySelector()` Defines a MessageSelector to find a reply to this message.
`long`	`getSendBegin()`
`long`	`getSendTime()`
`long`	`getSeqNum()` For CDPQ
`RouterInfo`	`getTarget()` Specifies the router to which the message should be delivered.
`long`	`getTransportQueued()`
`void`	`resetCreatedTime()` Reset creation time for dispatch age tracking on requeue
`void`	`setEnqueueTime(long now)` For CDQ
`void`	`setOnFailedReplyJob(Job job)` setOnFailedReplyJob.
`void`	`setOnFailedSendJob(Job job)` setOnFailedSendJob.
`void`	`setOnReplyJob(ReplyJob job)` setOnReplyJob.
`void`	`setOnSendJob(Job job)` setOnSendJob.
`void`	`setReplySelector(MessageSelector selector)` setReplySelector.
`void`	`setSeqNum(long num)` For CDPQ
`void`	`setTransportQueued(long now)` When the message entered the transport queue (set by transport send()).
`void`	`timestamp(String eventName)` Stamp the message's progress.
`String`	`toString()` toString.
`int`	`transportFailed(String transportStyle)` As of 0.9.55, returns the previous number of failed transports.

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

- Field Detail
  - PRIORITY_BUILD_REPLY
```
public static final int PRIORITY_BUILD_REPLY
```
    Build reply priority
    See Also:
    Constant Field Values
  - PRIORITY_EXPLORATORY
```
public static final int PRIORITY_EXPLORATORY
```
    Exploratory priority
    See Also:
    Constant Field Values
  - PRIORITY_HIGHEST
```
public static final int PRIORITY_HIGHEST
```
    Highest priority
    See Also:
    Constant Field Values
  - PRIORITY_HIS_BUILD_REQUEST
```
public static final int PRIORITY_HIS_BUILD_REQUEST
```
    His build request priority
    See Also:
    Constant Field Values
  - PRIORITY_HIS_NETDB_STORE
```
public static final int PRIORITY_HIS_NETDB_STORE
```
    His netdb store priority
    See Also:
    Constant Field Values
  - PRIORITY_LOWEST
```
public static final int PRIORITY_LOWEST
```
    Priorities, higher is higher priority. Lowest priority.
    See Also:
    Constant Field Values
  - PRIORITY_MEDIUM
```
public static final int PRIORITY_MEDIUM
```
    Medium priority
    See Also:
    Constant Field Values
  - PRIORITY_MY_BUILD_REQUEST
```
public static final int PRIORITY_MY_BUILD_REQUEST
```
    My build request priority
    See Also:
    Constant Field Values
  - PRIORITY_MY_DATA
```
public static final int PRIORITY_MY_DATA
```
    My data priority
    See Also:
    Constant Field Values
  - PRIORITY_MY_NETDB_LOOKUP
```
public static final int PRIORITY_MY_NETDB_LOOKUP
```
    My netdb lookup priority
    See Also:
    Constant Field Values
  - PRIORITY_MY_NETDB_STORE
```
public static final int PRIORITY_MY_NETDB_STORE
```
    My netdb store priority
    See Also:
    Constant Field Values
  - PRIORITY_MY_NETDB_STORE_LOW
```
public static final int PRIORITY_MY_NETDB_STORE_LOW
```
    My netdb store low priority
    See Also:
    Constant Field Values
  - PRIORITY_NETDB_EXPLORE
```
public static final int PRIORITY_NETDB_EXPLORE
```
    Netdb explore priority
    See Also:
    Constant Field Values
  - PRIORITY_NETDB_FLOOD
```
public static final int PRIORITY_NETDB_FLOOD
```
    Netdb flood priority
    See Also:
    Constant Field Values
  - PRIORITY_NETDB_HARVEST
```
public static final int PRIORITY_NETDB_HARVEST
```
    Netdb harvest priority
    See Also:
    Constant Field Values
  - PRIORITY_NETDB_REPLY
```
public static final int PRIORITY_NETDB_REPLY
```
    Netdb reply priority
    See Also:
    Constant Field Values
  - PRIORITY_PARTICIPATING
```
public static final int PRIORITY_PARTICIPATING
```
    Participating priority
    See Also:
    Constant Field Values
- Constructor Detail
  - OutNetMessage
```
public OutNetMessage(RouterContext context)
```
    Null msg and target, zero expiration (used in OutboundMessageRegistry only)
    Parameters:
    context - the router context
  - OutNetMessage
```
public OutNetMessage(RouterContext context,
                     I2NPMessage msg,
                     long expiration,
                     int priority,
                     RouterInfo target)
```
    Standard constructor
    Parameters:
    context - the router context
    msg - generally non-null
    expiration - the expiration time
    priority - the priority
    target - generally non-null
- Method Detail
  - beginSend
```
public void beginSend()
```
    begin the send
  - discardData
```
public void discardData()
```
    We've done what we need to do with the data from this message, though we may keep the object around for a while to use its ID, jobs, etc.
  - drop
```
public void drop()
```
    For CDQ
    Specified by:
    drop in interface CDQEntry
  - getCreated
```
public long getCreated()
```
    Returns:
    the creation time
  - getEnqueueTime
```
public long getEnqueueTime()
```
    For CDQ
    Specified by:
    getEnqueueTime in interface CDQEntry
    Returns:
    the enqueue time
  - getExpiration
```
public long getExpiration()
```
    Specify the # ms since the epoch after which if the message has not been sent the OnFailedSend job should be fired and the message should be removed from the pool. If the message has already been sent, this expiration is ignored and the expiration from the ReplySelector is used.
    Returns:
    the expiration time
  - getFailedTransportCount
```
public int getFailedTransportCount()
```
    Returns:
    the number of failed transports
  - getFailedTransports
```
public List<String> getFailedTransports()
```
    As of 0.9.55, changed from a Set to a List
    Returns:
    the list of failed transports
  - getLifetime
```
public long getLifetime()
```
    Returns:
    the remaining lifetime
  - getMessage
```
public I2NPMessage getMessage()
```
    Specifies the message to be sent. Generally non-null but may be null in special cases.
    Returns:
    the message
  - getMessageData
```
public int getMessageData(byte[] outBuffer)
```
    Copies the message data to outbuffer. Used only by VM Comm System.
    Parameters:
    outBuffer - the buffer to copy to
    Returns:
    the length, or -1 if message is null
  - getMessageId
```
public long getMessageId()
```
    Returns:
    the message ID
  - getMessageSize
```
public int getMessageSize()
```
    How large the message is, including the full 16 byte header. Transports with different header sizes should adjust.
    Returns:
    the message size
  - getMessageType
```
public String getMessageType()
```
    For debugging only.
    Returns:
    the simple class name
  - getMessageTypeId
```
public int getMessageTypeId()
```
    Returns:
    the message type ID
  - getOnFailedReplyJob
```
public Job getOnFailedReplyJob()
```
    If the Message selector is specified but it doesn't find a reply before its expiration passes, this job is enqueued.
    Returns:
    the onFailedReply job
  - getOnFailedSendJob
```
public Job getOnFailedSendJob()
```
    If the router could not be reached or the expiration passed, this job is enqueued.
    Returns:
    the onFailedSend job
  - getOnReplyJob
```
public ReplyJob getOnReplyJob()
```
    If the MessageSelector detects a reply, this job is enqueued
    Returns:
    the onReply job
  - getOnSendJob
```
public Job getOnSendJob()
```
    After the message is successfully passed to the router specified, the given job is enqueued.
    Returns:
    the onSend job
  - getPriority
```
public int getPriority()
```
    Specify the priority of the message, where higher numbers are higher priority. Higher priority messages should be delivered before lower priority ones, though some algorithm may be used to avoid starvation.
    Specified by:
    getPriority in interface PQEntry
    Returns:
    the priority
  - getReplySelector
```
public MessageSelector getReplySelector()
```
    Defines a MessageSelector to find a reply to this message.
    Returns:
    the reply selector
  - getSendBegin
```
public long getSendBegin()
```
    Returns:
    when the sending process began
  - getSendTime
```
public long getSendTime()
```
    Returns:
    the send time
  - getSeqNum
```
public long getSeqNum()
```
    For CDPQ
    Specified by:
    getSeqNum in interface PQEntry
    Returns:
    the seq num
  - getTarget
```
public RouterInfo getTarget()
```
    Specifies the router to which the message should be delivered. Generally non-null but may be null in special cases.
    Returns:
    the target router
  - getTransportQueued
```
public long getTransportQueued()
```
    Returns:
    when the message was queued
  - resetCreatedTime
```
public void resetCreatedTime()
```
    Reset creation time for dispatch age tracking on requeue
  - setEnqueueTime
```
public void setEnqueueTime(long now)
```
    For CDQ
    Specified by:
    setEnqueueTime in interface CDQEntry
    Parameters:
    now - the enqueue timestamp
  - setOnFailedReplyJob
```
public void setOnFailedReplyJob(Job job)
```
    setOnFailedReplyJob.
  - setOnFailedSendJob
```
public void setOnFailedSendJob(Job job)
```
    setOnFailedSendJob.
  - setOnReplyJob
```
public void setOnReplyJob(ReplyJob job)
```
    setOnReplyJob.
  - setOnSendJob
```
public void setOnSendJob(Job job)
```
    setOnSendJob.
  - setReplySelector
```
public void setReplySelector(MessageSelector selector)
```
    setReplySelector.
  - setSeqNum
```
public void setSeqNum(long num)
```
    For CDPQ
    Specified by:
    setSeqNum in interface PQEntry
    Parameters:
    num - the sequence number
  - setTransportQueued
```
public void setTransportQueued(long now)
```
    When the message entered the transport queue (set by transport send()).
    Parameters:
    now - the queue time
  - timestamp
```
public void timestamp(String eventName)
```
    Stamp the message's progress. Only useful if log level is INFO or DEBUG
    Parameters:
    eventName - what occurred
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class Object
  - transportFailed
```
public int transportFailed(String transportStyle)
```
    As of 0.9.55, returns the previous number of failed transports.
    Parameters:
    transportStyle - the transport that failed
    Returns:
    the number of previously failed transports

Class OutNetMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIORITY_BUILD_REPLY

PRIORITY_EXPLORATORY

PRIORITY_HIGHEST

PRIORITY_HIS_BUILD_REQUEST

PRIORITY_HIS_NETDB_STORE

PRIORITY_LOWEST

PRIORITY_MEDIUM

PRIORITY_MY_BUILD_REQUEST

PRIORITY_MY_DATA

PRIORITY_MY_NETDB_LOOKUP

PRIORITY_MY_NETDB_STORE

PRIORITY_MY_NETDB_STORE_LOW

PRIORITY_NETDB_EXPLORE

PRIORITY_NETDB_FLOOD

PRIORITY_NETDB_HARVEST

PRIORITY_NETDB_REPLY

PRIORITY_PARTICIPATING

Constructor Detail

OutNetMessage

OutNetMessage

Method Detail

beginSend

discardData

drop

getCreated

getEnqueueTime

getExpiration

getFailedTransportCount

getFailedTransports

getLifetime

getMessage

getMessageData

getMessageId

getMessageSize

getMessageType

getMessageTypeId

getOnFailedReplyJob

getOnFailedSendJob

getOnReplyJob

getOnSendJob

getPriority

getReplySelector

getSendBegin

getSendTime

getSeqNum

getTarget

getTransportQueued

resetCreatedTime

setEnqueueTime

setOnFailedReplyJob

setOnFailedSendJob

setOnReplyJob

setOnSendJob

setReplySelector

setSeqNum

setTransportQueued

timestamp

toString

transportFailed