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

java.lang.Object
- org.klomp.snark.Message

```
class Message
extends Object
```
Represents a BitTorrent protocol message for peer communication.
This class encapsulates all BitTorrent protocol message types including:
- Control messages: keep-alive, choke, unchoke, interested, uninterested
- Piece messages: have, bitfield, request, piece, cancel
- Extension messages for protocol extensions
- Fast peer extension messages (BEP 6)
- DHT messages (BEP 5, BEP 52)
Messages are created and queued for sending through a DataOutputStream. The sendMessage() method translates messages to wire format.
Message structure includes:
- type - The message type byte
- piece - The piece index (for have, request, piece, cancel)
- begin - The offset within the piece
- length - The data length
- data - Optional payload data
See Also:
PeerState

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static byte`	`ALLOWED_FAST` A l l o w e d f a s t
`(package private) int`	`begin` The offset within the piece
`(package private) static byte`	`BITFIELD` B i t f i e l d
`(package private) static byte`	`CANCEL` C a n c e l
`(package private) static byte`	`CHOKE` C h o k e
`(package private) byte[]`	`data` The data payload
`(package private) static byte`	`EXTENSION` E x t e n s i o n
`(package private) static byte`	`HASH_REJECT` H a s h r e j e c t
`(package private) static byte`	`HASH_REQUEST` H a s h r e q u e s t
`(package private) static byte`	`HASHES` H a s h e s
`(package private) static byte`	`HAVE` H a v e
`(package private) static byte`	`HAVE_ALL` H a v e a l l
`(package private) static byte`	`HAVE_NONE` H a v e n o n e
`(package private) static byte`	`INTERESTED` I n t e r e s t e d
`(package private) static byte`	`KEEP_ALIVE` K e e p a l i v e
`(package private) int`	`len` The payload length
`(package private) int`	`length` The data length
`(package private) int`	`off` The data offset
`(package private) int`	`piece` The piece index
`(package private) static byte`	`PIECE` P i e c e
`(package private) static byte`	`PORT` P o r t
`(package private) static byte`	`REJECT` R e j e c t
`(package private) static byte`	`REQUEST` R e q u e s t
`(package private) static byte`	`SUGGEST` S u g g e s t
`(package private) byte`	`type` The message type
`(package private) static byte`	`UNCHOKE` U n c h o k e
`(package private) static byte`	`UNINTERESTED` U n i n t e r e s t e d

Constructor Summary

Constructors
Constructor and Description
`Message(byte type)` For types KEEP_ALIVE, CHOKE, UNCHOKE, INTERESTED, UNINTERESTED, HAVE_ALL, HAVE_NONE
`Message(byte[] data)` For type BITFIELD
`Message(byte type, int piece)` For types HAVE, PORT, SUGGEST, ALLOWED_FAST
`Message(byte type, int piece, int begin, int length)` For types REQUEST, REJECT, CANCEL
`Message(int id, byte[] data)` For type EXTENSION
`Message(int piece, int begin, int length, DataLoader loader)` For type PIECE with deferred data

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`sendMessage(DataOutputStream dos)` Sends this message through the given DataOutputStream.
`String`	`toString()`

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

- Field Detail
  - ALLOWED_FAST
```
static final byte ALLOWED_FAST
```
    A l l o w e d f a s t
    See Also:
    Constant Field Values
  - begin
```
final int begin
```
    The offset within the piece
  - BITFIELD
```
static final byte BITFIELD
```
    B i t f i e l d
    See Also:
    Constant Field Values
  - CANCEL
```
static final byte CANCEL
```
    C a n c e l
    See Also:
    Constant Field Values
  - CHOKE
```
static final byte CHOKE
```
    C h o k e
    See Also:
    Constant Field Values
  - data
```
byte[] data
```
    The data payload
  - EXTENSION
```
static final byte EXTENSION
```
    E x t e n s i o n
    See Also:
    Constant Field Values
  - HASH_REJECT
```
static final byte HASH_REJECT
```
    H a s h r e j e c t
    See Also:
    Constant Field Values
  - HASH_REQUEST
```
static final byte HASH_REQUEST
```
    H a s h r e q u e s t
    See Also:
    Constant Field Values
  - HASHES
```
static final byte HASHES
```
    H a s h e s
    See Also:
    Constant Field Values
  - HAVE
```
static final byte HAVE
```
    H a v e
    See Also:
    Constant Field Values
  - HAVE_ALL
```
static final byte HAVE_ALL
```
    H a v e a l l
    See Also:
    Constant Field Values
  - HAVE_NONE
```
static final byte HAVE_NONE
```
    H a v e n o n e
    See Also:
    Constant Field Values
  - INTERESTED
```
static final byte INTERESTED
```
    I n t e r e s t e d
    See Also:
    Constant Field Values
  - KEEP_ALIVE
```
static final byte KEEP_ALIVE
```
    K e e p a l i v e
    See Also:
    Constant Field Values
  - len
```
final int len
```
    The payload length
  - length
```
final int length
```
    The data length
  - off
```
final int off
```
    The data offset
  - piece
```
final int piece
```
    The piece index
  - PIECE
```
static final byte PIECE
```
    P i e c e
    See Also:
    Constant Field Values
  - PORT
```
static final byte PORT
```
    P o r t
    See Also:
    Constant Field Values
  - REJECT
```
static final byte REJECT
```
    R e j e c t
    See Also:
    Constant Field Values
  - REQUEST
```
static final byte REQUEST
```
    R e q u e s t
    See Also:
    Constant Field Values
  - SUGGEST
```
static final byte SUGGEST
```
    S u g g e s t
    See Also:
    Constant Field Values
  - type
```
final byte type
```
    The message type
  - UNCHOKE
```
static final byte UNCHOKE
```
    U n c h o k e
    See Also:
    Constant Field Values
  - UNINTERESTED
```
static final byte UNINTERESTED
```
    U n i n t e r e s t e d
    See Also:
    Constant Field Values
- Constructor Detail
  - Message
```
Message(byte type)
```
    For types KEEP_ALIVE, CHOKE, UNCHOKE, INTERESTED, UNINTERESTED, HAVE_ALL, HAVE_NONE
  - Message
```
Message(byte[] data)
```
    For type BITFIELD
  - Message
```
Message(byte type,
        int piece)
```
    For types HAVE, PORT, SUGGEST, ALLOWED_FAST
  - Message
```
Message(byte type,
        int piece,
        int begin,
        int length)
```
    For types REQUEST, REJECT, CANCEL
  - Message
```
Message(int id,
        byte[] data)
```
    For type EXTENSION
  - Message
```
Message(int piece,
        int begin,
        int length,
        DataLoader loader)
```
    For type PIECE with deferred data
- Method Detail
  - sendMessage
```
void sendMessage(DataOutputStream dos)
          throws IOException
```
    Sends this message through the given DataOutputStream.
    Parameters:
    dos - the output stream to write to
    Throws:
    IOException - if an I/O error occurs
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
    Returns:
    a string representation of the message

Class Message

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALLOWED_FAST

begin

BITFIELD

CANCEL

CHOKE

data

EXTENSION

HASH_REJECT

HASH_REQUEST

HASHES

HAVE

HAVE_ALL

HAVE_NONE

INTERESTED

KEEP_ALIVE

len

length

off

piece

PIECE

PORT

REJECT

REQUEST

SUGGEST

type

UNCHOKE

UNINTERESTED

Constructor Detail

Message

Message

Message

Message

Message

Message

Method Detail

sendMessage

toString