org.gridgain.grid.util.nio

Interface GridCommunicationClient

All Known Implementing Classes:

GridAbstractCommunicationClient, GridShmemCommunicationClient, GridTcpCommunicationClient, GridTcpNioCommunicationClient

public interface GridCommunicationClient

Method Summary

Methods

Modifier and Type	Method and Description
boolean	async()
boolean	close()
boolean	closed()
void	doHandshake(GridInClosure2X<InputStream,OutputStream> handshakeC) Executes the given handshake closure on opened client passing underlying IO streams.
void	flushIfNeeded(long timeout)
void	forceClose() Forces client close.
long	getIdleTime() Gets idle time of this client.
void	release() Releases this client by decreasing reservations.
boolean	reserve()
boolean	reserved()
void	sendMessage(byte[] data, int len)
void	sendMessage(ByteBuffer data)
void	sendMessage(UUID nodeId, GridTcpCommunicationMessageAdapter msg)

Method Detail

doHandshake

void doHandshake(GridInClosure2X<InputStream,OutputStream> handshakeC)
                 throws GridException

Executes the given handshake closure on opened client passing underlying IO streams. This method pulled to client interface a handshake is only operation requiring access to both output and input streams.

Parameters:

handshakeC - Handshake.

Throws:

GridException - If handshake failed.

close

boolean close()

Returns:

True if client has been closed by this call, false if failed to close client (due to concurrent reservation or concurrent close).

forceClose

void forceClose()

Forces client close.

closed

boolean closed()

Returns:

True if client is closed;

reserve

boolean reserve()

Returns:

True if client was reserved, false otherwise.

release

void release()

Releases this client by decreasing reservations.

reserved

boolean reserved()

Returns:

True if client was reserved.

getIdleTime

long getIdleTime()

Gets idle time of this client.

Returns:

Idle time of this client.

sendMessage

void sendMessage(ByteBuffer data)
                 throws GridException

Parameters:

data - Data to send.

Throws:

GridException - If failed.

sendMessage

void sendMessage(byte[] data,
               int len)
                 throws GridException

Parameters:

data - Data to send.

len - Length.

Throws:

GridException - If failed.

sendMessage

void sendMessage(@Nullable
               UUID nodeId,
               GridTcpCommunicationMessageAdapter msg)
                 throws GridException

Parameters:

nodeId - Node ID (provided only if versions of local and remote nodes are different).

msg - Message to send.

Throws:

GridException - If failed.

flushIfNeeded

void flushIfNeeded(long timeout)
                   throws IOException

Parameters:

timeout - Timeout.

Throws:

IOException - If failed.

async

boolean async()

Returns:

True if send is asynchronous.