org.thales.punch.netty.impl

Class NettyHttpClientImpl

java.lang.Object

org.thales.punch.netty.impl.NettyAbstractEndpoint

org.thales.punch.netty.impl.NettyAbstractClient

org.thales.punch.netty.impl.NettyHttpClientImpl

All Implemented Interfaces:

INettyReaderCallback<Map<String,Object>>, NettyTcpClient<String>

public class NettyHttpClientImpl
extends NettyAbstractClient
implements INettyReaderCallback<Map<String,Object>>, NettyTcpClient<String>

The HttpClient.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FRAME_SIZE_DEFAULT_VALUE
static String	MAX_FRAME_SIZE_KEY

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

Method Summary

Modifier and Type	Method and Description
Class<?>	getType()
void	onReceive(io.netty.channel.ChannelHandlerContext ctx, INettyTuple<Map<String,Object>> in) Called when the underlying client has received some data from the server Do nothing now.
NettyTcpClient<String>	setCallback(INettyReaderCallback<Map<String,Object>> callback)
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.
NettyHttpClientImpl	start() Start the client.
NettyTcpClient<String>	stop() Stop the client.
boolean	write(String data) Write some line of data to the server.
boolean	write(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, toString, wait, wait, wait

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

onActive, onInactive, onThrowable

Field Detail

MAX_FRAME_SIZE_KEY

public static final String MAX_FRAME_SIZE_KEY

See Also:

Constant Field Values

MAX_FRAME_SIZE_DEFAULT_VALUE

public static final int MAX_FRAME_SIZE_DEFAULT_VALUE

See Also:

Constant Field Values

Constructor Detail

NettyHttpClientImpl

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

Return a new NettyHttpTcpClient. 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,
                      INettyTuple<Map<String,Object>> in)

Called when the underlying client has received some data from the server Do nothing now. TODO.

Specified by:

onReceive in interface INettyReaderCallback<Map<String,Object>>

Parameters:

ctx - the receiving channel context .

in - the received data.

write

public boolean write(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<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(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<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 NettyHttpClientImpl 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

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

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

setCallback

public NettyTcpClient<String> setCallback(INettyReaderCallback<Map<String,Object>> callback)

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<Map<String,Object>>

Returns:

the associated return type.