ExtensionHandler (Javadocs [I2P+ 2.13.0+]

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

abstract class ExtensionHandler
extends Object

REF: BEP 10 Extension Protocol

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ID_COMMENT`
`static int`	`ID_DHT` DHT extension message ID (3).
`static int`	`ID_HANDSHAKE` Handshake extension message ID (0).
`static int`	`ID_LT_DONTHAVE` BEP 54 lt_donthave extension message ID (5).
`static int`	`ID_METADATA` Metadata extension message ID (1).
`static int`	`ID_PEX` PEX extension message ID (2).
`static String`	`TYPE_COMMENT`
`static String`	`TYPE_DHT` Not using the option bit since the compact format is different.
`static String`	`TYPE_LT_DONTHAVE` BEP 54 lt_donthave extension type string.
`static String`	`TYPE_METADATA` Metadata extension type string.
`static String`	`TYPE_PEX` Not ut_pex since the compact format is different.

Constructor Summary
Constructors
Constructor and Description
ExtensionHandler()

Constructors
Constructor and Description
`ExtensionHandler()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte[]`	`getHandshake(int metasize, boolean pexAndMetadata, boolean dht, boolean uploadOnly, boolean comment, String clientName)` Creates a bencoded extension handshake message.
`static void`	`handleMessage(Peer peer, PeerListener listener, int id, byte[] bs)` Handles an incoming extension message from a peer.
`static void`	`locked_sendComments(Peer peer, int num, CommentSet comments)` Sends comments to a peer.
`static void`	`sendCommentReq(Peer peer, int num)` Sends a comment request to a peer.
`static void`	`sendDHT(Peer peer, int qport, int rport)` Sends DHT port numbers to a peer.
`static void`	`sendDontHave(Peer peer, int piece)` Send a BEP 54 lt_donthave message to a peer that advertised support: the piece is no longer available.
`static void`	`sendPEX(Peer peer, List<Peer> pList)` Sends a PEX message with the given peer list.

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

- Field Detail
  - ID_COMMENT
```
public static final int ID_COMMENT
```
    See Also:
    Constant Field Values
  - ID_DHT
```
public static final int ID_DHT
```
    DHT extension message ID (3).
    See Also:
    Constant Field Values
  - ID_HANDSHAKE
```
public static final int ID_HANDSHAKE
```
    Handshake extension message ID (0).
    See Also:
    Constant Field Values
  - ID_LT_DONTHAVE
```
public static final int ID_LT_DONTHAVE
```
    BEP 54 lt_donthave extension message ID (5).
    See Also:
    Constant Field Values
  - ID_METADATA
```
public static final int ID_METADATA
```
    Metadata extension message ID (1).
    See Also:
    Constant Field Values
  - ID_PEX
```
public static final int ID_PEX
```
    PEX extension message ID (2).
    See Also:
    Constant Field Values
  - TYPE_COMMENT
```
public static final String TYPE_COMMENT
```
    See Also:
    Constant Field Values
  - TYPE_DHT
```
public static final String TYPE_DHT
```
    Not using the option bit since the compact format is different.
    See Also:
    Constant Field Values
  - TYPE_LT_DONTHAVE
```
public static final String TYPE_LT_DONTHAVE
```
    BEP 54 lt_donthave extension type string.
    See Also:
    Constant Field Values
  - TYPE_METADATA
```
public static final String TYPE_METADATA
```
    Metadata extension type string.
    See Also:
    Constant Field Values
  - TYPE_PEX
```
public static final String TYPE_PEX
```
    Not ut_pex since the compact format is different.
    See Also:
    Constant Field Values
- Constructor Detail
  - ExtensionHandler
```
ExtensionHandler()
```
- Method Detail
  - getHandshake
```
public static byte[] getHandshake(int metasize,
                                  boolean pexAndMetadata,
                                  boolean dht,
                                  boolean uploadOnly,
                                  boolean comment,
                                  String clientName)
```
    Creates a bencoded extension handshake message.
    Parameters:
    metasize - the metadata size in bytes, or -1 if unknown
    pexAndMetadata - true to advertise PEX and metadata extensions
    dht - true to advertise DHT capability
    uploadOnly - true to advertise upload-only mode (BEP 21)
    comment - true to advertise ut_comment extension
    clientName - the "v" value, or null for the default "I2PSnark"
    Returns:
    bencoded outgoing handshake message
  - handleMessage
```
public static void handleMessage(Peer peer,
                                 PeerListener listener,
                                 int id,
                                 byte[] bs)
```
    Handles an incoming extension message from a peer.
    Parameters:
    peer - the peer
    listener - the peer listener for callbacks
    id - the extension message ID
    bs - the raw message bytes
  - locked_sendComments
```
public static void locked_sendComments(Peer peer,
                                       int num,
                                       CommentSet comments)
```
    Sends comments to a peer. Caller must synchronize on comments.
    Parameters:
    peer - the peer
    num - the maximum number of comments to send
    comments - non-null set of comments to send
  - sendCommentReq
```
public static void sendCommentReq(Peer peer,
                                  int num)
```
    Sends a comment request to a peer.
    Parameters:
    peer - the peer
    num - the maximum number of comments to request
  - sendDHT
```
public static void sendDHT(Peer peer,
                           int qport,
                           int rport)
```
    Sends DHT port numbers to a peer.
    Parameters:
    peer - the peer
    qport - the query port
    rport - the response port
  - sendDontHave
```
public static void sendDontHave(Peer peer,
                                int piece)
```
    Send a BEP 54 lt_donthave message to a peer that advertised support: the piece is no longer available. The payload is the raw 4-byte piece index.
    Parameters:
    peer - the peer to send to
    piece - the piece index
  - sendPEX
```
public static void sendPEX(Peer peer,
                           List<Peer> pList)
```
    Sends a PEX message with the given peer list. added.f and dropped are unsupported.
    Parameters:
    peer - the peer
    pList - non-null list of peers to share

Class ExtensionHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_COMMENT

ID_DHT

ID_HANDSHAKE

ID_LT_DONTHAVE

ID_METADATA

ID_PEX

TYPE_COMMENT

TYPE_DHT

TYPE_LT_DONTHAVE

TYPE_METADATA

TYPE_PEX

Constructor Detail

ExtensionHandler

Method Detail

getHandshake

handleMessage

locked_sendComments

sendCommentReq

sendDHT

sendDontHave

sendPEX