org.thales.punch.netty.impl

Class NettyTcpClientImpl

java.lang.Object

org.thales.punch.netty.impl.NettyAbstractEndpoint

org.thales.punch.netty.impl.NettyAbstractClient

org.thales.punch.netty.impl.NettyTcpClientImpl

All Implemented Interfaces:

INettyReaderCallback<String>, NettyTcpClient<String>

public class NettyTcpClientImpl
extends NettyAbstractClient
implements INettyReaderCallback<String>, NettyTcpClient<String>

The NIO client sends out events as string on a tcp socket.

It uses a single socket towards the destination. That socket is created and connected whenever the first message is sent, or after the socket was closed by the peer.

This output is blocking, that is, if the peer is slow, this output will hang so that the peer can catch up. This makes this output's input queue grow and accumulate messages.

Author:

dimi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyTcpClientImpl.Item

Field Summary

Fields

Modifier and Type	Field and Description
static String	DROP_IF_SLOW
static boolean	DROP_IF_SLOW_DEFAULT_VALUE

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
NettyTcpClientImpl(org.thales.punch.settings.api.ISettingsMap settings, org.thales.punch.libraries.metrics.api.IMetricContext metricsContext, NettyDataAcker acker) Return a new NettyTcpClient.

Method Summary

Modifier and Type	Method and Description
Class<?>	getType()
void	onReceive(io.netty.channel.ChannelHandlerContext ctx, INettyTuple<String> data) Called when a NettySocketServer has received data.
NettyTcpClient<String>	setConnectionCallback(INettyConnectionCallback cb) Request to be told upon connection/disconnection with the target server.
NettyTcpClient<String>	setName(String name) Associate a name to the client.
NettyTcpClientImpl	start() Start the client.
NettyTcpClient<String>	stop() Stop the client.
String	toString()
boolean	write(String data) Write some data to the server.
boolean	write(String data, Object ctx) Write some data to the server.

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

Methods inherited from interface org.thales.punch.netty.api.INettyReaderCallback

onActive, onInactive, onThrowable

Field Detail

DROP_IF_SLOW

public static final String DROP_IF_SLOW

See Also:

Constant Field Values

DROP_IF_SLOW_DEFAULT_VALUE

public static final boolean DROP_IF_SLOW_DEFAULT_VALUE

See Also:

Constant Field Values

Constructor Detail

NettyTcpClientImpl

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

Return a new NettyTcpClient. 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

start

public NettyTcpClientImpl start()

Description copied from interface: NettyTcpClient

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.

Specified by:

start in interface NettyTcpClient<String>

Returns:

this client

onReceive

public void onReceive(io.netty.channel.ChannelHandlerContext ctx,
                      INettyTuple<String> data)

Description copied from interface: INettyReaderCallback

Called when a NettySocketServer has received data.

Specified by:

onReceive in interface INettyReaderCallback<String>

Parameters:

ctx - the receiving channel context .

data - the received data.

write

public boolean write(String data)
              throws NettyException

Write some data to the server.

Note that you data is not sent synchronously. When you return nothing may have happened. If the input queue is full, you can make the whole client fail or wait with the drop_if_slow

Specified by:

write in interface NettyTcpClient<String>

Parameters:

data - the data to send

Returns:

true if the item was scheduled for writing

Throws:

NettyException

write

public boolean write(String data,
                     Object ctx)
              throws NettyException

Write some data to the server. You can pass some object, that will be returned to you once the data has been acknowledged by the server.

Note that you data is not sent synchronously. When you return nothing may have happened.

Specified by:

write in interface NettyTcpClient<String>

Parameters:

data - the data to send

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

Returns:

true if the item was scheduled for writing

Throws:

NettyException

toString

public String toString()

Overrides:

toString in class Object

setConnectionCallback

public NettyTcpClient<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<String>

Parameters:

cb - the user callback

Returns:

this client

stop

public NettyTcpClient<String> stop()

Description copied from interface: NettyTcpClient

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

Specified by:

stop in interface NettyTcpClient<String>

Returns:

this client

setName

public NettyTcpClient<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<String>

Parameters:

name - the client name

Returns:

this client

getType

public Class<?> getType()

Specified by:

getType in interface INettyReaderCallback<String>

Returns:

the associated return type.