Package convex.net

Class Connection

java.lang.Object

convex.net.Connection

public class Connection
extends Object

Class representing the low-level NIO network Connection between network participants.

Sent messages are sent asynchronously via the shared client selector.

Received messages are read by the shared client selector, converted into Message instances, and passed to a Consumer for handling.

A Connection "owns" the ByteChannel associated with this Peer connection

Method Summary

Modifier and Type	Method	Description
void	close()
static Connection	connect(InetSocketAddress socketAddress, Consumer<Message> receiveAction, AStore store)	Create a Connection by connecting to a remote address
static Connection	connect(InetSocketAddress socketAddress, Consumer<Message> receiveAction, AStore store, AccountKey trustedPeerKey)	Create a Connection by connecting to a remote address
static Connection	connect(InetSocketAddress socketAddress, Consumer<Message> receiveAction, AStore store, AccountKey trustedPeerKey, int sendBufferSize, int receiveBufferSize)	Create a Connection by connecting to a remote address
static Connection	create(ByteChannel channel, Consumer<Message> receiveAction, AStore store, AccountKey trustedPeerKey)	Create a PeerConnection using an existing channel.
void	finalize()
boolean	flushBytes()	Sends bytes buffered into the underlying channel.
long	getLastActivity()
InetSocketAddress	getLocalAddress()	Returns the local SocketAddress associated with this connection, or null if not available
long	getNextID()
long	getReceivedCount()
InetSocketAddress	getRemoteAddress()	Returns the remote SocketAddress associated with this connection, or null if not available
AStore	getStore()	Gets the store associated with this Connection
AccountKey	getTrustedPeerKey()
int	handleChannelRecieve()	Handles receipt of bytes from the channel on this Connection.
boolean	isClosed()	Checks if this connection is closed (i.e.
boolean	isTrusted()
protected static void	selectRead(SelectionKey key)	Handles channel reads from a SelectionKey for the client listener SECURITY: Called on Connection Selector Thread
long	sendChallenge(SignedData<ACell> challenge)	Sends a CHALLENGE Request Message on this connection.
boolean	sendData(Blob data)	Sends a DATA Message on this connection.
boolean	sendMessage(Message msg)	Sends a message over this connection
long	sendQuery(ACell form)	Sends a QUERY Message on this connection with a null Address
long	sendQuery(ACell form, Address address)	Sends a QUERY Message on this connection.
long	sendResponse(SignedData<ACell> response)	Sends a RESPONSE Request Message on this connection.
long	sendStatusRequest()	Sends a STATUS Request Message on this connection.
long	sendTransaction(SignedData<ATransaction> signed)	Sends a transaction if possible, returning the message ID (greater than zero) if successful.
void	setReceiveHook(Consumer<Message> hook)	Sets an optional additional message receiver hook (for debugging / observability purposes)
void	setTrustedPeerKey(AccountKey value)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

create

public static Connection create(ByteChannel channel,
 Consumer<Message> receiveAction,
 AStore store,
 AccountKey trustedPeerKey)
                         throws IOException

Create a PeerConnection using an existing channel. Does not perform any connection initialisation: channel should already be connected.

Parameters:

channel - Byte channel to wrap

receiveAction - Consumer to be called when a Message is received

store - Store to use when receiving messages.

trustedPeerKey - Trusted peer account key if this is a trusted connection, if not then null*

Returns:

New Connection instance

Throws:

IOException - If IO error occurs

connect

public static Connection connect(InetSocketAddress socketAddress,
 Consumer<Message> receiveAction,
 AStore store)
                          throws IOException,
TimeoutException

Create a Connection by connecting to a remote address

Parameters:

socketAddress - Address to connect to

receiveAction - A callback Consumer to be called for any received messages on this connection

store - Store to use for this Connection

Returns:

New Connection instance

Throws:

IOException - If connection fails because of any IO problem

TimeoutException - If connection cannot be established within an acceptable time (~5s)

connect

public static Connection connect(InetSocketAddress socketAddress,
 Consumer<Message> receiveAction,
 AStore store,
 AccountKey trustedPeerKey)
                          throws IOException,
TimeoutException

Create a Connection by connecting to a remote address

Parameters:

socketAddress - Address to connect to

receiveAction - A callback Consumer to be called for any received messages on this connection

store - Store to use for this Connection

trustedPeerKey - Trusted peer account key if this is a trusted connection, if not then null

Returns:

New Connection instance

Throws:

IOException - If connection fails because of any IO problem

TimeoutException - If the connection cannot be established within the timeout period

connect

public static Connection connect(InetSocketAddress socketAddress,
 Consumer<Message> receiveAction,
 AStore store,
 AccountKey trustedPeerKey,
 int sendBufferSize,
 int receiveBufferSize)
                          throws IOException,
TimeoutException

Create a Connection by connecting to a remote address

Parameters:

socketAddress - Internet Address to connect to

receiveAction - A callback Consumer to be called for any received messages on this connection

store - Store to use for this Connection

trustedPeerKey - Trusted peer account key if this is a trusted connection, if not then null

sendBufferSize - Size of connection send buffer in bytes

receiveBufferSize - Size of connection receive buffer in bytes

Returns:

New Connection instance

Throws:

IOException - If connection fails because of any IO problem

TimeoutException - If the connection cannot be established within the timeout period

getReceivedCount

public long getReceivedCount()

setReceiveHook

public void setReceiveHook(Consumer<Message> hook)

Sets an optional additional message receiver hook (for debugging / observability purposes)

Parameters:

hook - Hook to call when a message is received

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Returns the remote SocketAddress associated with this connection, or null if not available

Returns:

An InetSocketAddress if associated, otherwise null

getStore

public AStore getStore()

Gets the store associated with this Connection

Returns:

Store instance

getLocalAddress

public InetSocketAddress getLocalAddress()

Returns the local SocketAddress associated with this connection, or null if not available

Returns:

A SocketAddress if associated, otherwise null

sendData

public boolean sendData(Blob data)
                 throws IOException

Sends a DATA Message on this connection. Does not send embedded values.

Parameters:

data - Encoded data object

Returns:

true if buffered successfully, false otherwise (not sent)

Throws:

IOException - If IO error occurs

sendQuery

public long sendQuery(ACell form)
               throws IOException

Sends a QUERY Message on this connection with a null Address

Parameters:

form - A data object representing the query form

Returns:

The ID of the message sent, or -1 if send buffer is full.

Throws:

IOException - If IO error occurs

sendQuery

public long sendQuery(ACell form,
 Address address)
               throws IOException

Sends a QUERY Message on this connection.

Parameters:

form - A data object representing the query form

address - The address with which to run the query, which may be null

Returns:

The ID of the message sent, or -1 if send buffer is full.

Throws:

IOException - If IO error occurs

sendStatusRequest

public long sendStatusRequest()
                       throws IOException

Sends a STATUS Request Message on this connection.

Returns:

The ID of the message sent, or -1 if send buffer is full.

Throws:

IOException - If IO error occurs

sendChallenge

public long sendChallenge(SignedData<ACell> challenge)
                   throws IOException

Sends a CHALLENGE Request Message on this connection.

Parameters:

challenge - Challenge a Vector that has been signed by the sending peer.

Returns:

The ID of the message sent, or -1 if the message cannot be sent.

Throws:

IOException - If IO error occurs

sendResponse

public long sendResponse(SignedData<ACell> response)
                  throws IOException

Sends a RESPONSE Request Message on this connection.

Parameters:

response - Signed response for the remote peer

Returns:

The ID of the message sent, or -1 if the message cannot be sent.

Throws:

IOException - If IO error occurs

sendTransaction

public long sendTransaction(SignedData<ATransaction> signed)
                     throws IOException

Sends a transaction if possible, returning the message ID (greater than zero) if successful. Uses the configured CLIENT_STORE to store the transaction, so that any missing data requests from the server can be honoured. Returns -1 if the message could not be sent because of a full buffer.

Parameters:

signed - Signed transaction

Returns:

Message ID of the transaction request, or -1 if send buffer is full.

Throws:

IOException - In the event of an IO error, e.g. closed connection

sendMessage

public boolean sendMessage(Message msg)

Sends a message over this connection

Parameters:

msg - Message to send

Returns:

true if message buffered successfully, false if failed

close

public void close()

finalize

public void finalize()

Overrides:

finalize in class Object

isClosed

public boolean isClosed()

Checks if this connection is closed (i.e. the underlying channel is closed)

Returns:

true if the channel is closed, false otherwise.

selectRead

protected static void selectRead(SelectionKey key)
                          throws IOException

Handles channel reads from a SelectionKey for the client listener SECURITY: Called on Connection Selector Thread

Parameters:

key -

Throws:

IOException

handleChannelRecieve

public int handleChannelRecieve()
                         throws IOException,
BadFormatException

Handles receipt of bytes from the channel on this Connection. Will switch the current store to the Connection-specific store if required. SECURITY: Called on NIO Thread (Server or client Connection)

Returns:

The number of bytes read from channel, or -1 if EOS

Throws:

IOException - If IO error occurs

BadFormatException - If there is an encoding error

flushBytes

public boolean flushBytes()
                   throws IOException

Sends bytes buffered into the underlying channel.

Returns:

True if all bytes are sent, false otherwise

Throws:

IOException - If an IO Exception occurs

toString

public String toString()

Overrides:

toString in class Object

getTrustedPeerKey

public AccountKey getTrustedPeerKey()

setTrustedPeerKey

public void setTrustedPeerKey(AccountKey value)

isTrusted

public boolean isTrusted()

getLastActivity

public long getLastActivity()

getNextID

public long getNextID()