org.thales.punch.netty.api

Interface NettyTcpClient<T>

Type Parameters:

T - the underlying data type

All Known Implementing Classes:

NettyHttpClientImpl, NettyLumberJackClientImpl, NettyTcpClientImpl

public interface NettyTcpClient<T>

The Netty tcp client simply sends data to a tcp server. As of today you have three possible implementations : a plain TCP, HTTP or Lumberjack client. They all implement this interface.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
NettyTcpClient<T>	setConnectionCallback(INettyConnectionCallback cb) Request to be told upon connection/disconnection with the target server.
NettyTcpClient<T>	setName(String name) Associate a name to the client.
NettyTcpClient<T>	start() Start the client.
NettyTcpClient<T>	stop() Stop the client.
boolean	write(T data) Write some line of data to the server.
boolean	write(T data, Object context) Write some line of data to the server using an acknowledgement mode.

Method Detail

write

boolean write(T data)
       throws NettyException

Write some line of data to the server. This is a oneway, unacknowledged sending. If you use it on top of a acknowledge-enable client, the ack will not be reported back to your Acker.

Parameters:

data - the data to send

Returns:

true if the item was scheduled for writing

Throws:

NettyException - if the client queue capacity is reached and the connection to the server is down for more than the configured timeout.

write

boolean write(T data,
              Object context)
       throws NettyException

Write some line of data to the server using an acknowledgement mode. The logic of this method is an asynchronous sending over a socket. It fails only if the underlying client queue capacity is exceeded, or if the client is not connected anynore. In that case an exception is thrown.

Parameters:

data - the data to send

context - some opaque context you need for the ack or fail callback.

Returns:

true if the item was scheduled for writing

Throws:

NettyException - if the client queue capacity is reached and the connection to the server is down for more than the configured timeout.

start

NettyTcpClient<T> start()

Start the client. This starts a dedicated thread that will automatically connect to the peer, and subscribe to any data to send. If the peer is not there or temporarilly go away, the client will keep trying reconnecting.

Returns:

this client

stop

NettyTcpClient<T> stop()

Stop the client. This shutdowns the sending?connecting thread.

Returns:

this client

setConnectionCallback

NettyTcpClient<T> setConnectionCallback(INettyConnectionCallback cb)

Request to be told upon connection/disconnection with the target server.

It can be null and will have no effect.

Parameters:

cb - the user callback

Returns:

this client

setName

NettyTcpClient<T> setName(String name)

Associate a name to the client. This is used to name the corresponding threads.

Parameters:

name - the client name

Returns:

this client