Package org.graylog2.inputs.transports

Class UdpTransport

java.lang.Object

org.graylog2.plugin.inputs.transports.NettyTransport

org.graylog2.inputs.transports.UdpTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

NetFlowUdpTransport

public class UdpTransport
extends NettyTransport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UdpTransport.Config
static interface	UdpTransport.Factory

Field Summary

Fields inherited from class org.graylog2.plugin.inputs.transports.NettyTransport

CK_BIND_ADDRESS, CK_NUMBER_WORKER_THREADS, CK_PORT, CK_RECV_BUFFER_SIZE, eventLoopGroupFactory, localRegistry, socketAddress, throughputCounter, workerThreads

Constructor Summary

Constructors

Constructor	Description
UdpTransport(Configuration configuration, EventLoopGroupFactory eventLoopGroupFactory, NettyTransportConfiguration nettyTransportConfiguration, ThroughputCounter throughputCounter, LocalMetricRegistry localRegistry)

Method Summary

Modifier and Type	Method	Description
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 LinkedHashMap<String,Callable<? extends io.netty.channel.ChannelHandler>>	getChildChannelHandlers(MessageInput input)	Subclasses can override this to modify the channel handlers for child channels.
SocketAddress	getLocalAddress()	Get the local socket address this transport is listening on after being launched.
void	launch(MessageInput input)
void	stop()

Methods inherited from class org.graylog2.plugin.inputs.transports.NettyTransport

getAggregator, getChannelInitializer, getCustomChildChannelHandlers, getMetricSet, getRecvBufferSize, setMessageAggregator

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

Constructor Details

UdpTransport

public UdpTransport(Configuration configuration,
 EventLoopGroupFactory eventLoopGroupFactory,
 NettyTransportConfiguration nettyTransportConfiguration,
 ThroughputCounter throughputCounter,
 LocalMetricRegistry localRegistry)

Method Details

getChannelHandlers

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

Description copied from class: NettyTransport

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.

Overrides:

getChannelHandlers in class NettyTransport

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

getChildChannelHandlers

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

Description copied from class: NettyTransport

Subclasses can override this to modify the channel handlers for child channels. The default handlers in this group are all channel handlers returned by NettyTransport.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.

Specified by:

getChildChannelHandlers in class NettyTransport

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:

• NettyTransport.getCustomChildChannelHandlers(MessageInput)

launch

public void launch(MessageInput input)
            throws MisfireException

Throws:

MisfireException

stop

public void stop()

getLocalAddress

@Nullable
public SocketAddress getLocalAddress()

Description copied from class: NettyTransport

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

Specified by:

getLocalAddress in class NettyTransport

Returns:

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