RelayUtils (TomP2P nat 5.0-Alpha27-SNAPSHOT API)

java.lang.Object
- net.tomp2p.relay.RelayUtils

```
public class RelayUtils
extends Object
```

Method Summary

Methods
Modifier and Type	Method and Description
`static io.netty.buffer.ByteBuf`	`composeMessageBuffer(List<Message> messages, SignatureFactory signatureFactory)` Composes all messages of a list into a single buffer object, ready to be transmitted over the network.
`static FutureResponse`	`connectAndSend(Peer peer, Message message, ConnectionConfiguration config)` Opens a new peer connection to the receiver and sends the message through it.
`static Message`	`decodeMessage(Buffer buf, InetSocketAddress recipient, InetSocketAddress sender, SignatureFactory signatureFactory)` Decodes a message which was encoded using {`encodeMessage(Message, SignatureFactory)`}.
`static Message`	`decodeRelayedMessage(Buffer buf, InetSocketAddress recipient, InetSocketAddress sender, SignatureFactory signatureFactory)` Basically does the same as `MessageUtils#decodeMessage(Buffer, InetSocketAddress, InetSocketAddress, SignatureFactory)`, but in addition checks that the relay peers of the decoded message are set correctly
`static String`	`decodeString(Buffer buffer)` Decodes buffer containing a String
`static List<Message>`	`decomposeCompositeBuffer(io.netty.buffer.ByteBuf messageBuffer, InetSocketAddress recipient, InetSocketAddress sender, SignatureFactory signatureFactory)` Decomposes a buffer containing multiple buffers into an (ordered) list of small buffers.
`static Buffer`	`encodeMessage(Message message, SignatureFactory signatureFactory)` Encodes a message into a buffer, such that it can be used as a message payload (piggybacked), stored, etc.
`static Buffer`	`encodeString(String content)` Encodes any String into a buffer to send it with a message
`static Collection<PeerAddress>`	`flatten(List<Map<Number160,PeerStatistic>> maps)`
`static int`	`getMessageSize(Message message, SignatureFactory signatureFactory)` Calculates the size of the message
`static FutureResponse`	`send(PeerConnection peerConnection, PeerBean peerBean, ConnectionBean connectionBean, ConnectionConfiguration config, Message message)` Send a Message from one Peer to another Peer internally.
`static List<Map<Number160,PeerStatistic>>`	`unflatten(Collection<PeerAddress> map, PeerAddress sender)`

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

Method Detail

unflatten

public static List<Map<Number160,PeerStatistic>> unflatten(Collection<PeerAddress> map,
                                           PeerAddress sender)

flatten

public static Collection<PeerAddress> flatten(List<Map<Number160,PeerStatistic>> maps)

decodeRelayedMessage

public static Message decodeRelayedMessage(Buffer buf,
                           InetSocketAddress recipient,
                           InetSocketAddress sender,
                           SignatureFactory signatureFactory)
                                    throws InvalidKeyException,
                                           NoSuchAlgorithmException,
                                           InvalidKeySpecException,
                                           SignatureException,
                                           IOException

Basically does the same as MessageUtils#decodeMessage(Buffer, InetSocketAddress, InetSocketAddress, SignatureFactory), but in addition checks that the relay peers of the decoded message are set correctly

Throws:: InvalidKeyException; NoSuchAlgorithmException; InvalidKeySpecException; SignatureException; IOException

composeMessageBuffer
```
public static io.netty.buffer.ByteBuf composeMessageBuffer(List<Message> messages,
                                           SignatureFactory signatureFactory)
```
Composes all messages of a list into a single buffer object, ready to be transmitted over the network. The composing happens in-order. Alternatively, the message size and then the message is written to the buffer. Use MessageBuffer#decomposeCompositeBuffer(ByteBuf) to disassemble.

Parameters:
messages - the messages to compose
signatureFactory - the signature factory, necessary for encoding the messages

Returns:
a single buffer holding all messages of the list

decomposeCompositeBuffer

public static List<Message> decomposeCompositeBuffer(io.netty.buffer.ByteBuf messageBuffer,
                                     InetSocketAddress recipient,
                                     InetSocketAddress sender,
                                     SignatureFactory signatureFactory)

Decomposes a buffer containing multiple buffers into an (ordered) list of small buffers. Alternating, the size of the message and the message itself are encoded in the message buffer. First, the size is read, then k bytes are read from the buffer (the message). Then again, the size of the next messages is determined.

Parameters:: messageBuffer - the message buffer
Returns:: a list of buffers

encodeMessage

public static Buffer encodeMessage(Message message,
                   SignatureFactory signatureFactory)
                            throws InvalidKeyException,
                                   SignatureException,
                                   IOException

Encodes a message into a buffer, such that it can be used as a message payload (piggybacked), stored, etc.

Throws:: InvalidKeyException; SignatureException; IOException

decodeMessage

public static Message decodeMessage(Buffer buf,
                    InetSocketAddress recipient,
                    InetSocketAddress sender,
                    SignatureFactory signatureFactory)
                             throws InvalidKeyException,
                                    NoSuchAlgorithmException,
                                    InvalidKeySpecException,
                                    SignatureException,
                                    IOException

Decodes a message which was encoded using {encodeMessage(Message, SignatureFactory)}.

Throws:: InvalidKeyException; NoSuchAlgorithmException; InvalidKeySpecException; SignatureException; IOException

getMessageSize

public static int getMessageSize(Message message,
                 SignatureFactory signatureFactory)
                          throws InvalidKeyException,
                                 SignatureException,
                                 IOException

Calculates the size of the message

Throws:: InvalidKeyException; SignatureException; IOException

encodeString
```
public static Buffer encodeString(String content)
```
Encodes any String into a buffer to send it with a message

Parameters:
content - the String to encode into a buffer

Returns:
a buffer containing the (encoded) String.

decodeString
```
public static String decodeString(Buffer buffer)
```
Decodes buffer containing a String

Parameters:
buffer - the buffer received in a message

Returns:
the encodeed String

send

public static FutureResponse send(PeerConnection peerConnection,
                  PeerBean peerBean,
                  ConnectionBean connectionBean,
                  ConnectionConfiguration config,
                  Message message)

Send a Message from one Peer to another Peer internally. This avoids the overhead of sendDirect. This Method is used for relaying and reverse Connection setup.

Returns:: the response

connectAndSend

public static FutureResponse connectAndSend(Peer peer,
                            Message message,
                            ConnectionConfiguration config)

Opens a new peer connection to the receiver and sends the message through it.

Parameters:: peer -; message -; config -
Returns:

Class RelayUtils