org.graylog2.gelfclient.transport

Interface GelfTransport

All Known Implementing Classes:

AbstractGelfTransport, GelfTcpTransport, GelfUdpTransport

public interface GelfTransport

A common interface for all GELF network transports.

Method Summary

Modifier and Type	Method and Description
void	flushAndStopSynchronously(int waitDuration, TimeUnit timeUnit, int retries) Blocks and stops the transport after flushing/sending all enqueued messages.
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.

Method Detail

send

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.

Parameters:

message - message to send to the remote host

Throws:

InterruptedException

trySend

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.

Parameters:

message - message to send to the remote host

Returns:

true if the message could be dispatched, false otherwise

stop

void stop()

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

flushAndStopSynchronously

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.

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.