org.thales.punch.netty.relp.impl

Class NettyRelpTuple

java.lang.Object

org.thales.punch.netty.relp.impl.NettyRelpTuple

All Implemented Interfaces:

INettyTuple<RELPFrame>

public class NettyRelpTuple
extends Object
implements INettyTuple<RELPFrame>

A tuple containing a RELP frame.

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
NettyRelpTuple(RELPFrame frame, io.netty.channel.ChannelHandlerContext ctx, RELPEncoder encoder) Ctor

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.
RELPFrame	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.
static io.netty.buffer.ByteBuf	toByteBuf(byte[] bb)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyRelpTuple

public NettyRelpTuple(RELPFrame frame,
                      io.netty.channel.ChannelHandlerContext ctx,
                      RELPEncoder encoder)

Ctor

Parameters:

frame -

ctx -

encoder -

Method Detail

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: INettyTuple

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

Specified by:

getLocalAddress in interface INettyTuple<RELPFrame>

Returns:

the local address

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: INettyTuple

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

Specified by:

getRemoteAddress in interface INettyTuple<RELPFrame>

Returns:

the peer address

getData

public RELPFrame getData()

Description copied from interface: INettyTuple

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.

Specified by:

getData in interface INettyTuple<RELPFrame>

Returns:

the data

fail

public void fail()

Description copied from interface: INettyTuple

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.

Specified by:

fail in interface INettyTuple<RELPFrame>

ack

public void ack()

Description copied from interface: INettyTuple

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.

Specified by:

ack in interface INettyTuple<RELPFrame>

toString

public String toString()

Overrides:

toString in class Object

toByteBuf

public static io.netty.buffer.ByteBuf toByteBuf(byte[] bb)

getDataLength

public int getDataLength()

Specified by:

getDataLength in interface INettyTuple<RELPFrame>