org.thales.punch.netty.api

Interface INettyTuple<T>

Type Parameters:

T - the data type

All Known Implementing Classes:

NettyHttpTuple, NettyHttpTupleEmpty, NettyLumberJackTuple, NettyLumberJackTupleEmpty, NettyRelpTuple, NettyTupleImpl

public interface INettyTuple<T>

You receive INettyTuple whenever a netty client or server receives some data. This class lets you acknowledge the data (assuming the underlying client and server support that), and, of course, retrieve the received data.

Method Summary

Modifier and Type	Method and Description
void	ack() Acknowledge that NettyData.
void	fail() Signal the peer about the failure to process that NettyData.
T	getData() The general case is to receive a Json document (as is, or lumberjack encoded), made of key value pairs.
int	getDataLength()
InetSocketAddress	getLocalAddress() Get the local (i.e.
InetSocketAddress	getRemoteAddress() Get the remote (i.e.

Method Detail

getData

T getData()

The general case is to receive a Json document (as is, or lumberjack encoded), made of key value pairs. The map returned will then contains several entries. This occurs for instance with the Lumberjack protocol.

If however a single String is received, for instance from a syslog plain client, then you will find a single entry. To avoid the burden and the performance penalty to always retrieve it from a map, you can use the getSingleData method.

Returns:

the data

fail

void fail()

Signal the peer about the failure to process that NettyData.

What action will be taken is up to the underlying connector. It will be a no-operation if the connector does not support an acknowledged mode.

ack

void ack()

Acknowledge that NettyData.

What happens is up to the underlying connector. It will be a no-operation if the connector does not support an acknowledged mode.

getLocalAddress

InetSocketAddress getLocalAddress()

Get the local (i.e. listening) address.

Returns:

the local address

getRemoteAddress

InetSocketAddress getRemoteAddress()

Get the remote (i.e. the peer) address.

Returns:

the peer address

getDataLength

int getDataLength()