org.graylog2.gelfclient.transport

Class AbstractGelfTransport

java.lang.Object

org.graylog2.gelfclient.transport.AbstractGelfTransport

All Implemented Interfaces:

GelfTransport

Direct Known Subclasses:

GelfTcpTransport, GelfUdpTransport

public abstract class AbstractGelfTransport
extends Object
implements GelfTransport

An abstract GelfTransport implementation serving as parent for the concrete implementations.

This class is thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected GelfConfiguration	config
protected BlockingQueue<GelfMessage>	queue

Constructor Summary

Constructors

Constructor and Description
AbstractGelfTransport(GelfConfiguration config) Creates a new GELF transport with the given configuration.
AbstractGelfTransport(GelfConfiguration config, BlockingQueue<GelfMessage> queue) Creates a new GELF transport with the given configuration and BlockingQueue.

Method Summary

Modifier and Type	Method and Description
protected abstract void	createBootstrap(io.netty.channel.EventLoopGroup workerGroup)
void	flushAndStopSynchronously(int waitDuration, TimeUnit timeUnit, int retries) Blocks and stops the transport after flushing/sending all enqueued messages.
protected void	scheduleReconnect(io.netty.channel.EventLoopGroup workerGroup)
void	send(GelfMessage message) Sends the given message to the remote host.
void	stop() Stops the transport.
boolean	trySend(GelfMessage message) Tries to send the given message to the remote host.

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final GelfConfiguration config

queue

protected final BlockingQueue<GelfMessage> queue

Constructor Detail

AbstractGelfTransport

public AbstractGelfTransport(GelfConfiguration config,
                             BlockingQueue<GelfMessage> queue)

Creates a new GELF transport with the given configuration and BlockingQueue.

Parameters:

config - the client configuration

queue - the BlockingQueue used to buffer GELF messages

AbstractGelfTransport

public AbstractGelfTransport(GelfConfiguration config)

Creates a new GELF transport with the given configuration.

Parameters:

config - the client configuration

Method Detail

createBootstrap

protected abstract void createBootstrap(io.netty.channel.EventLoopGroup workerGroup)

scheduleReconnect

protected void scheduleReconnect(io.netty.channel.EventLoopGroup workerGroup)

send

public void send(GelfMessage message)
          throws InterruptedException

Sends the given message to the remote host. This blocks until there is sufficient capacity to process the message. It is not guaranteed that the message has been sent once the method call returns because a queue might be used to dispatch the message.

This implementation is backed by a BlockingQueue. When this method returns the message has been added to the BlockingQueue but has not been sent to the remote host yet.

Specified by:

send in interface GelfTransport

Parameters:

message - message to send to the remote host

Throws:

InterruptedException

trySend

public boolean trySend(GelfMessage message)

Tries to send the given message to the remote host. It does not block if there is not enough capacity to process the message. It is not guaranteed that the message has been sent once the method call returns because a queue might be used to dispatch the message.

This implementation is backed by a BlockingQueue. When this method returns the message has been added to the BlockingQueue but has not been sent to the remote host yet.

Specified by:

trySend in interface GelfTransport

Parameters:

message - message to send to the remote host

Returns:

true if the message could be dispatched, false otherwise

stop

public void stop()

Stops the transport. Can be used to gracefully shutdown the backend.

Specified by:

stop in interface GelfTransport

flushAndStopSynchronously

public void flushAndStopSynchronously(int waitDuration,
                                      TimeUnit timeUnit,
                                      int retries)

Blocks and stops the transport after flushing/sending all enqueued messages. Blocking occurs until either all messages are flushed, or the indicated waitDuration, timeUnit and retries have elapsed. Each retry waits for the indicated waitDuration and timeUnit again. This can be used to gracefully shutdown the backend.

Specified by:

flushAndStopSynchronously in interface GelfTransport

Parameters:

waitDuration - the wait duration.

timeUnit - the time unit for the waitDuration.

retries - the number of times to retry and wait for messages to flush. Zero retries indicates that one initial attempt will be made.