io.datakernel.eventloop

Interface AsyncTcpSocket

All Known Implementing Classes:

AsyncSslSocket, AsyncTcpSocketImpl

public interface AsyncTcpSocket

Common interface for connection-oriented transport protocols.

Contains operations for reading and writing ByteBuf. All read and write operations must be performed asynchronously

Implementations are supposed to use Decorator and Observer patterns which allows to easily cascade protocol as in OSI model. For example SSL works on top of TCP, therefore AsyncSslSocket writes encrypted data to AsyncTcpSocketImpl, and at the same time AsyncSslSocket is event handler of AsyncTcpSocketImpl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AsyncTcpSocket.EventHandler Handles events of socket

Method Summary

Modifier and Type	Method and Description
void	close() Closes socket, regardless of any remaining buffered data.
InetSocketAddress	getRemoteSocketAddress()
void	read() Must be called to inform the async socket that additional read data is needed.
void	setEventHandler(AsyncTcpSocket.EventHandler eventHandler)
void	write(ByteBuf buf) Asynchronously writes data to network.
void	writeEndOfStream() Informs socket that no more data will be written.

Method Detail

setEventHandler

void setEventHandler(AsyncTcpSocket.EventHandler eventHandler)

read

void read()

Must be called to inform the async socket that additional read data is needed.

Unless called, the socket won't read any data from network and therefore won't invoke AsyncTcpSocket.EventHandler.onRead(ByteBuf) callback.

Each read invocation may result in at most one AsyncTcpSocket.EventHandler.onRead(ByteBuf) callbacks.

This operation is idempotent and may be called several times prior to actual onRead callbacks.

write

void write(ByteBuf buf)

Asynchronously writes data to network.

When written data is flushed, AsyncTcpSocket.EventHandler.onWrite() method will be called

Parameters:

buf - bytes of data

writeEndOfStream

void writeEndOfStream()

Informs socket that no more data will be written. Any pending write data is expected to be delivered with corresponding AsyncTcpSocket.EventHandler.onWrite() confirmation. This operation is idempotent. No subsequent AsyncTcpSocket.EventHandler.onWrite() operations on the socket must be called afterwards.

close

void close()

Closes socket, regardless of any remaining buffered data. This operation is idempotent. No subsequent operations on the socket must be called afterwards.

After calling this method no more event handler methods will be invoked

getRemoteSocketAddress

InetSocketAddress getRemoteSocketAddress()