Package 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	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	Description
static final String	CK_BIND_ADDRESS
static final String	CK_NUMBER_WORKER_THREADS
static final String	CK_PORT
static final String	CK_RECV_BUFFER_SIZE
protected final EventLoopGroupFactory	eventLoopGroupFactory
protected final com.codahale.metrics.MetricRegistry	localRegistry
protected final InetSocketAddress	socketAddress
protected final ThroughputCounter	throughputCounter
protected final int	workerThreads

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected CodecAggregator	getAggregator()
protected LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>>	getChannelHandlers(MessageInput input)	Subclasses can override this to add additional channel handlers to the Netty ChannelPipeline to support additional features.
protected io.netty.channel.ChannelInitializer<? extends io.netty.channel.Channel>	getChannelInitializer(LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>> handlerList)
protected abstract LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>>	getChildChannelHandlers(MessageInput input)	Subclasses can override this to modify the channel handlers for child channels.
protected LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>>	getCustomChildChannelHandlers(MessageInput input)	Subclasses can override this to modify the channel handlers at the end of the pipeline for child channels.
abstract SocketAddress	getLocalAddress()	Get the local socket address this transport is listening on after being launched.
com.codahale.metrics.MetricSet	getMetricSet()
protected int	getRecvBufferSize()
void	setMessageAggregator(CodecAggregator aggregator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.plugin.inputs.transports.Transport

launch, launch, stop

Field Details

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

CK_NUMBER_WORKER_THREADS

public static final String CK_NUMBER_WORKER_THREADS

See Also:

• Constant Field Values

eventLoopGroupFactory

protected final EventLoopGroupFactory eventLoopGroupFactory

localRegistry

protected final com.codahale.metrics.MetricRegistry localRegistry

socketAddress

protected final InetSocketAddress socketAddress

throughputCounter

protected final ThroughputCounter throughputCounter

workerThreads

protected final int workerThreads

Constructor Details

NettyTransport

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

Method Details

getChannelInitializer

protected io.netty.channel.ChannelInitializer<? extends io.netty.channel.Channel> getChannelInitializer(LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>> handlerList)

getLocalAddress

@Nullable
public abstract 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.

setMessageAggregator

public void setMessageAggregator(@Nullable
 CodecAggregator aggregator)

Specified by:

setMessageAggregator in interface Transport

getAggregator

@Nullable
protected CodecAggregator getAggregator()

getChannelHandlers

protected LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>> getChannelHandlers(MessageInput input)

Subclasses can override this to add additional channel handlers to the Netty ChannelPipeline to support additional features. Some common use cases are to add connection counters or traffic shapers.

Parameters:

input - The MessageInput for which these channel handlers are being added

Returns:

list of initial channel handlers to add to the Netty channel pipeline

getCustomChildChannelHandlers

protected LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>> getCustomChildChannelHandlers(MessageInput input)

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

Parameters:

input - The MessageInput for which these child channel handlers are being added

Returns:

list of custom channel handlers to add to the Netty channel pipeline for child channels

getChildChannelHandlers

protected abstract LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>> getChildChannelHandlers(MessageInput input)

Subclasses can override this to modify the channel handlers for child channels. The default handlers in this group are all channel handlers returned by getCustomChildChannelHandlers(MessageInput), the optional aggregation handler (e.g. for chunked GELF via UDP) and the RawMessageHandler (in that order). Usually overriding this method should only be necessary if you have a codec that cannot create a RawMessage for incoming messages at the end of the pipeline. A valid use case would be to insert debug handlers in the middle of the list, though.

Parameters:

input - The MessageInput for which these child channel handlers are being added

Returns:

list of custom channel handlers to add to the Netty channel pipeline for child channels

See Also:

• getCustomChildChannelHandlers(MessageInput)

getRecvBufferSize

protected int getRecvBufferSize()

getMetricSet

public com.codahale.metrics.MetricSet getMetricSet()

Specified by:

getMetricSet in interface Transport