org.graylog2.plugin.inputs.transports

Class NettyTransport

java.lang.Object

org.graylog2.plugin.inputs.transports.NettyTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

AbstractTcpTransport, UdpTransport

public abstract class NettyTransport
extends Object
implements Transport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyTransport.Config

Nested classes/interfaces inherited from interface org.graylog2.plugin.inputs.transports.Transport

Transport.Factory<T extends Transport>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CK_BIND_ADDRESS
static String	CK_PORT
static String	CK_RECV_BUFFER_SIZE
protected com.codahale.metrics.MetricRegistry	localRegistry
protected ThroughputCounter	throughputCounter

Constructor Summary

Constructors

Constructor and Description
NettyTransport(Configuration configuration, ThroughputCounter throughputCounter, LocalMetricRegistry localRegistry)

Method Summary

Modifier and Type	Method and Description
protected LinkedHashMap<String,Callable<? extends org.jboss.netty.channel.ChannelHandler>>	getBaseChannelHandlers(MessageInput input) Subclasses can override this to add additional ChannelHandlers to the pipeline to support additional features.
protected abstract org.jboss.netty.bootstrap.Bootstrap	getBootstrap() Construct a ServerBootstrap to use with this transport.
protected LinkedHashMap<String,Callable<? extends org.jboss.netty.channel.ChannelHandler>>	getFinalChannelHandlers(MessageInput input) Subclasses can override this to modify the channel handlers at the end of the pipeline.
SocketAddress	getLocalAddress() Get the local socket address this transport is listening on after being launched.
com.codahale.metrics.MetricSet	getMetricSet()
protected long	getRecvBufferSize()
void	launch(MessageInput input)
void	setMessageAggregator(CodecAggregator aggregator)
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

CK_BIND_ADDRESS

public static final String CK_BIND_ADDRESS

See Also:

Constant Field Values

CK_PORT

public static final String CK_PORT

See Also:

Constant Field Values

CK_RECV_BUFFER_SIZE

public static final String CK_RECV_BUFFER_SIZE

See Also:

Constant Field Values

localRegistry

protected final com.codahale.metrics.MetricRegistry localRegistry

throughputCounter

protected final ThroughputCounter throughputCounter

Constructor Detail

NettyTransport

public NettyTransport(Configuration configuration,
                      ThroughputCounter throughputCounter,
                      LocalMetricRegistry localRegistry)

Method Detail

setMessageAggregator

public void setMessageAggregator(@Nullable
                                 CodecAggregator aggregator)

Specified by:

setMessageAggregator in interface Transport

launch

public void launch(MessageInput input)
            throws MisfireException

Specified by:

launch in interface Transport

Throws:

MisfireException

stop

public void stop()

Specified by:

stop in interface Transport

getBootstrap

protected abstract org.jboss.netty.bootstrap.Bootstrap getBootstrap()

Construct a ServerBootstrap to use with this transport.

Set all the options on it you need to have, but do not set a ChannelPipelineFactory, it will be replaced with the augmented list of handlers returned by getBaseChannelHandlers(org.graylog2.plugin.inputs.MessageInput)

Returns:

a configured ServerBootstrap for this transport

getBaseChannelHandlers

protected LinkedHashMap<String,Callable<? extends org.jboss.netty.channel.ChannelHandler>> getBaseChannelHandlers(MessageInput input)

Subclasses can override this to add additional ChannelHandlers to the pipeline to support additional features.

Some common use cases are to add SSL/TLS, connection counters or throttling traffic shapers.

Parameters:

input -

Returns:

the list of initial channelhandlers to add to the ChannelPipelineFactory

getFinalChannelHandlers

protected LinkedHashMap<String,Callable<? extends org.jboss.netty.channel.ChannelHandler>> getFinalChannelHandlers(MessageInput input)

Subclasses can override this to modify the channel handlers at the end of the pipeline.

The default handlers in this group are the aggregation handler (e.g. for chunked GELF via UDP), which can be missing, and the NettyTransport.RawMessageHandler.

Usually this should not be necessary, only modify them if you have a codec that cannot create a RawMessage for incoming messages at the end of the pipeline.

One valid use case would be to insert debug handlers in the middle of the list, though.

Parameters:

input -

Returns:

the list of channel handlers at the end of the pipeline

getRecvBufferSize

protected long getRecvBufferSize()

getLocalAddress

public SocketAddress getLocalAddress()

Get the local socket address this transport is listening on after being launched.

Returns:

the listening address of this transport or null if the transport hasn't been launched yet.

getMetricSet

public com.codahale.metrics.MetricSet getMetricSet()

Specified by:

getMetricSet in interface Transport