org.thales.punch.netty.impl

Class NettyLumberJackClientImpl

java.lang.Object

org.thales.punch.netty.impl.NettyAbstractEndpoint

org.thales.punch.netty.impl.NettyAbstractClient

org.thales.punch.netty.impl.NettyLumberJackClientImpl

All Implemented Interfaces:

NettyTcpClient<Map<String,String>>, NettyReaderByteBufCallback

public class NettyLumberJackClientImpl
extends NettyAbstractClient
implements NettyReaderByteBufCallback, NettyTcpClient<Map<String,String>>

This client is in charge of sending outgoing data to a lumberjack peer.

In fact this class only defines the high level interface, the real work is performed by the NettyLumberJackClientRunner.

Field Summary

Fields inherited from class org.thales.punch.netty.impl.NettyAbstractClient

raw

Fields inherited from class org.thales.punch.netty.impl.NettyAbstractEndpoint

bootstrap, host, maxPayloadLength, metricsContext, port, protocol, readSocketTimeoutAction, readSocketTimeoutMs, ssl, sslCiphers, sslProtocol, sslProvider, useNettyCompression

Constructor Summary

Constructors

Constructor and Description
NettyLumberJackClientImpl(org.thales.punch.settings.api.ISettingsMap settings, org.thales.punch.libraries.metrics.api.IMetricContext metricsContext, NettyDataAcker acker) Return a new NettyLumberJackTcpClient.

Method Summary

Modifier and Type	Method and Description
protected void	onDisconnected(Throwable e)
void	onReceive(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf data, com.codahale.metrics.Counter rec, com.codahale.metrics.Counter sent) Called when the underlying client has received some data from the server
NettyTcpClient<Map<String,String>>	setConnectionCallback(INettyConnectionCallback cb) Request to be told upon connection/disconnection with the target server.
NettyTcpClient<Map<String,String>>	setName(String name) Associate a name to the client.
NettyLumberJackClientImpl	start() Start the client.
NettyTcpClient<Map<String,String>>	stop() Stop the client.
String	toString()
boolean	write(Map<String,String> data) Write some line of data to the server.
boolean	write(Map<String,String> data, Object context) Write some line of data to the server using an acknowledgement mode.

Methods inherited from class org.thales.punch.netty.impl.NettyAbstractClient

connect, getConnectIntervalMs, getConnectRetryIntervalMs, getSslContext, setConnectIntervalMs, setConnectRetryIntervalMs, shutdown

Methods inherited from class org.thales.punch.netty.impl.NettyAbstractEndpoint

getFileFromString, getSslProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyLumberJackClientImpl

public NettyLumberJackClientImpl(org.thales.punch.settings.api.ISettingsMap settings,
                                 org.thales.punch.libraries.metrics.api.IMetricContext metricsContext,
                                 NettyDataAcker acker)

Return a new NettyLumberJackTcpClient. The target host:port must be set in the settings.

Parameters:

settings - the client settings

metricsContext - the metric context

acker - the data acker

Method Detail

onReceive

public void onReceive(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf data,
                      com.codahale.metrics.Counter rec,
                      com.codahale.metrics.Counter sent)

Called when the underlying client has received some data from the server

Specified by:

onReceive in interface NettyReaderByteBufCallback

Parameters:

ctx - the receiving channel context .

data - the received data.

rec - the received data counter.

sent - the sent data counter.

write

public boolean write(Map<String,String> data)
              throws NettyException

Description copied from interface: NettyTcpClient

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.

Specified by:

write in interface NettyTcpClient<Map<String,String>>

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

public boolean write(Map<String,String> data,
                     Object context)

Description copied from interface: NettyTcpClient

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.

Specified by:

write in interface NettyTcpClient<Map<String,String>>

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

start

public NettyLumberJackClientImpl start()

Start the client. This launches a new thread that keeps trying to connect, once connected send the data.

Specified by:

start in interface NettyTcpClient<Map<String,String>>

Returns:

this client.

setConnectionCallback

public NettyTcpClient<Map<String,String>> setConnectionCallback(INettyConnectionCallback cb)

Description copied from interface: NettyTcpClient

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

It can be null and will have no effect.

Specified by:

setConnectionCallback in interface NettyTcpClient<Map<String,String>>

Parameters:

cb - the user callback

Returns:

this client

stop

public NettyTcpClient<Map<String,String>> stop()

Description copied from interface: NettyTcpClient

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

Specified by:

stop in interface NettyTcpClient<Map<String,String>>

Returns:

this client

setName

public NettyTcpClient<Map<String,String>> setName(String name)

Description copied from interface: NettyTcpClient

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

Specified by:

setName in interface NettyTcpClient<Map<String,String>>

Parameters:

name - the client name

Returns:

this client

toString

public String toString()

Overrides:

toString in class Object

onDisconnected

protected void onDisconnected(Throwable e)