フィールドの詳細

• _log

  protected final Log _log

• _context

  protected final I2PAppContext _context

• _expiration

  protected long _expiration

• _uniqueId

  protected long _uniqueId

  Warning, lazily initialized by readBytes(), writeBytes(), toByteArray(), getUniqueId(), and setUniqueId(); otherwise will be -1. Extending classes should take care when accessing this field; to ensure initialization, use getUniqueId() instead.

• DEFAULT_EXPIRATION_MS

  public static final long DEFAULT_EXPIRATION_MS

  関連項目:

  定数フィールド値

• CHECKSUM_LENGTH

  public static final int CHECKSUM_LENGTH

  関連項目:

  定数フィールド値

• HEADER_LENGTH

  public static final int HEADER_LENGTH

  16

  関連項目:

  定数フィールド値

コンストラクタの詳細

• I2NPMessageImpl

  public I2NPMessageImpl​(I2PAppContext context)

メソッドの詳細

• registerBuilder

  @Deprecated
  public static final void registerBuilder​(I2NPMessageImpl.Builder builder,
                                           int type)

  推奨されていません。 unused

• readBytes

  @Deprecated
  public void readBytes​(java.io.InputStream in)
                 throws DataFormatException,
                        java.io.IOException

  推奨されていません。 unused
  Read the whole message but only if it's exactly 1024 bytes. Unused - All transports provide encapsulation and so we have byte arrays available.

  定義:

  readBytes インタフェース内 DataStructure

  パラメータ:

  in - stream to read from

  例外:

  DataFormatException - if the data is improperly formatted

  java.io.IOException - if there was a problem reading the stream

• readBytes

  @Deprecated
  public int readBytes​(java.io.InputStream in,
                       int type,
                       byte[] buffer)
                throws I2NPMessageException,
                       java.io.IOException

  推奨されていません。 unused
  Read the header, then read the rest into buffer, then call readMessage in the implemented message type This does a copy from the stream to the buffer, so if you already have a byte array, use the other readBytes() instead.

    Specifically:
      1 byte type (if caller didn't read already, as specified by the type param
      4 byte ID
      8 byte expiration
      2 byte size
      1 byte checksum
      size bytes of payload (read by readMessage() in implementation)
  

  Unused - All transports provide encapsulation and so we have byte arrays available.

  定義:

  readBytes インタフェース内 I2NPMessage

  パラメータ:

  type - the message type or -1 if we should read it here

  buffer - temp buffer to use

  in - stream to read from starting at type if type is < 0 (16 byte header) starting at ID if type is >= 0 (15 byte header)

  戻り値:

  total length of the message

  例外:

  I2NPMessageException - if the stream doesn't contain a valid message that this class can read.

  java.io.IOException - if there is a problem reading from the stream

• readBytes

  public int readBytes​(byte[] data,
                       int type,
                       int offset)
                throws I2NPMessageException

  Read the header, then read the rest into buffer, then call readMessage in the implemented message type

    Specifically:
      1 byte type (if caller didn't read already, as specified by the type param
      4 byte ID
      8 byte expiration
      2 byte size
      1 byte checksum
      size bytes of payload (read by readMessage() in implementation)
  

  定義:

  readBytes インタフェース内 I2NPMessage

  パラメータ:

  type - the message type or -1 if we should read it here

  data - the data

  offset - where to start starting at type if type is < 0 (16 byte header) starting at ID if type is >= 0 (15 byte header)

  戻り値:

  total length of the message

  例外:

  I2NPMessageException - if there is no valid message

• readBytes

  public int readBytes​(byte[] data,
                       int type,
                       int offset,
                       int maxLen)
                throws I2NPMessageException

  Set a limit on the max to read from the data buffer, so that we can use a large buffer but prevent the reader from reading off the end.

  定義:

  readBytes インタフェース内 I2NPMessage

  パラメータ:

  maxLen - read no more than this many bytes from data starting at offset, even if it is longer This includes the type byte only if type < 0

  data - the data, may or may not include the type

  type - I2NP message type. If less than zero, read the type from data

  offset - where to start starting at type if type is < 0 (16 byte header) starting at ID if type is >= 0 (15 byte header)

  戻り値:

  size of the message read (including headers)

  例外:

  I2NPMessageException - if there is no valid message

  導入されたバージョン:

  0.8.12

• writeBytes

  @Deprecated
  public void writeBytes​(java.io.OutputStream out)
                  throws DataFormatException,
                         java.io.IOException

  推奨されていません。 unused
  Don't do this if you need a byte array - use toByteArray()

  定義:

  writeBytes インタフェース内 DataStructure

  パラメータ:

  out - stream to write to

  例外:

  DataFormatException - if the data was incomplete or not yet ready to be written

  java.io.IOException - if there was a problem writing to the stream

• getUniqueId

  public long getUniqueId​()

  Replay resistant message Id

  定義:

  getUniqueId インタフェース内 I2NPMessage

• setUniqueId

  public void setUniqueId​(long id)

  The ID is set to a random value when written but it can be overridden here.

  定義:

  setUniqueId インタフェース内 I2NPMessage

• getMessageExpiration

  public long getMessageExpiration​()

  Date after which the message should be dropped (and the associated uniqueId forgotten)

  定義:

  getMessageExpiration インタフェース内 I2NPMessage

• setMessageExpiration

  public void setMessageExpiration​(long exp)

  The expiration is set to one minute from now in the constructor but it can be overridden here.

  定義:

  setMessageExpiration インタフェース内 I2NPMessage

• getMessageSize

  public int getMessageSize​()

  インタフェースからコピーされた説明: I2NPMessage
  How large the message is, including any checksums, i.e. full 16 byte header

  定義:

  getMessageSize インタフェース内 I2NPMessage

• getRawMessageSize

  public int getRawMessageSize​()

  The raw header consists of a one-byte type and a 4-byte expiration in seconds only. Used by SSU only!

  定義:

  getRawMessageSize インタフェース内 I2NPMessage

• toByteArray

  public byte[] toByteArray​()

  定義:

  toByteArray インタフェース内 DataStructure

  オーバーライド:

  toByteArray クラス内 DataStructureImpl

  戻り値:

  may be null if data is not set

• toByteArray

  public int toByteArray​(byte[] buffer)

  インタフェースからコピーされた説明: I2NPMessage
  write the message to the buffer, returning the number of bytes written. the data is formatted so as to be self contained, with the type, size, expiration, unique id, as well as a checksum bundled along. Full 16 byte header.

  定義:

  toByteArray インタフェース内 I2NPMessage

• calculateWrittenLength

  protected abstract int calculateWrittenLength​()

  calculate the message body's length (not including the header and footer

• writeMessageBody

  protected abstract int writeMessageBody​(byte[] out,
                                          int curIndex)
                                   throws I2NPMessageException

  write the message body to the output array, starting at the given index.

  戻り値:

  the index into the array after the last byte written

  例外:

  I2NPMessageException

• toRawByteArray

  public int toRawByteArray​(byte[] buffer)

  Write the message with a short 5-byte header. THe header consists of a one-byte type and a 4-byte expiration in seconds only. Used by SSU only!

  定義:

  toRawByteArray インタフェース内 I2NPMessage

• readMessage

  public void readMessage​(byte[] data,
                          int offset,
                          int dataSize,
                          int type,
                          I2NPMessageHandler handler)
                   throws I2NPMessageException

  定義:

  readMessage インタフェース内 I2NPMessage

  例外:

  I2NPMessageException

• fromRawByteArray

  public static I2NPMessage fromRawByteArray​(I2PAppContext ctx,
                                             byte[] buffer,
                                             int offset,
                                             int len,
                                             I2NPMessageHandler handler)
                                      throws I2NPMessageException

  Read the message with a short 5-byte header. THe header consists of a one-byte type and a 4-byte expiration in seconds only. Used by SSU only!

  例外:

  I2NPMessageException

• createMessage

  public static I2NPMessage createMessage​(I2PAppContext context,
                                          int type)
                                   throws I2NPMessageException

  Yes, this is fairly ugly, but its the only place it ever happens.

  戻り値:

  non-null, returns an UnknownI2NPMessage if unknown type

  例外:

  I2NPMessageException