GelfConfiguration (gelfclient 1.4.0 API)

java.lang.Object
- org.graylog2.gelfclient.GelfConfiguration

public class GelfConfiguration
extends Object

The configuration used by a GelfTransport.

Constructor Summary

Constructors
Constructor and Description
`GelfConfiguration()` Creates a new configuration with the local hostname ("127.0.0.1") and the default port (12201).
`GelfConfiguration(InetSocketAddress remoteAddress)` Creates a new configuration with the given remote address.
`GelfConfiguration(int port)` Creates a new configuration with the local hostname ("127.0.0.1") and the given port.
`GelfConfiguration(String hostname)` Creates a new configuration with the given hostname and the default port (12201).
`GelfConfiguration(String hostname, int port)` Creates a new configuration with the given hostname and port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GelfConfiguration`	`connectTimeout(int connectTimeout)` Set the connection timeout for TCP connections in milliseconds.
`GelfConfiguration`	`disableTls()` Disable TLS for transport.
`GelfConfiguration`	`disableTlsCertVerification()` Disable TLS certificate verification for transport.
`GelfConfiguration`	`enableTls()` Enable TLS for transport.
`GelfConfiguration`	`enableTlsCertVerification()` Enable TLS certificate verification for transport.
`int`	`getConnectTimeout()` Get the connection timeout for TCP connections in milliseconds.
`String`	`getHostname()` Get the hostname of the GELF server.
`int`	`getMaxInflightSends()` Get the number of max queued network operations.
`int`	`getPort()` Get the port of the GELF server.
`int`	`getQueueSize()` Get the size of the internally used `BlockingQueue`.
`int`	`getReconnectDelay()` Get the time to wait between reconnects in milliseconds.
`InetSocketAddress`	`getRemoteAddress()` Get the remote address of the GELF server.
`int`	`getSendBufferSize()` Get the size of the socket send buffer in bytes.
`File`	`getTlsTrustCertChainFile()` Get the trust certificate chain file for the TLS connection.
`GelfTransports`	`getTransport()` Get the transport protocol used with the GELF server.
`boolean`	`isTcpKeepAlive()`
`boolean`	`isTcpNoDelay()` Whether Nagle's algorithm is enabled for TCP connections.
`boolean`	`isTlsCertVerificationEnabled()` Check if TLS certificate verification is enabled.
`boolean`	`isTlsEnabled()` Check if TLS option for the transport is enabled.
`GelfConfiguration`	`maxInflightSends(int maxInflightSends)` Set the number of max queued network operations.
`GelfConfiguration`	`queueSize(int size)` Set the size of the internally used `BlockingQueue`.
`GelfConfiguration`	`reconnectDelay(int reconnectDelay)` Set the time to wait between reconnects in milliseconds.
`GelfConfiguration`	`sendBufferSize(int sendBufferSize)` Set the size of the socket send buffer in bytes.
`GelfConfiguration`	`tcpKeepAlive(boolean tcpKeepAlive)`
`GelfConfiguration`	`tcpNoDelay(boolean tcpNoDelay)` Whether to use Nagle's algorithm for TCP connections.
`GelfConfiguration`	`tlsTrustCertChainFile(File tlsTrustCertChainFile)` Set the trust certificate chain file for the TLS connection.
`GelfConfiguration`	`transport(GelfTransports transport)` Set the transport protocol used with the GELF server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GelfConfiguration
```
public GelfConfiguration(String hostname,
                         int port)
```
    Creates a new configuration with the given hostname and port.
    
    Parameters:
    
    hostname - The hostname of the GELF-enabled server
    
    port - The port of the GELF-enabled server
  - GelfConfiguration
```
public GelfConfiguration(InetSocketAddress remoteAddress)
```
    Creates a new configuration with the given remote address.
    
    Parameters:
    
    remoteAddress - The InetSocketAddress of the GELF server
  - GelfConfiguration
```
public GelfConfiguration(String hostname)
```
    Creates a new configuration with the given hostname and the default port (12201).
    
    Parameters:
    
    hostname - The hostname of the GELF-enabled server
  - GelfConfiguration
```
public GelfConfiguration(int port)
```
    Creates a new configuration with the local hostname ("127.0.0.1") and the given port.
    
    Parameters:
    
    port - The port of the GELF-enabled server
  - GelfConfiguration
```
public GelfConfiguration()
```
    Creates a new configuration with the local hostname ("127.0.0.1") and the default port (12201).
- Method Detail
  - getHostname
```
public String getHostname()
```
    Get the hostname of the GELF server.
    
    Returns:
    
    the hostname of the GELF server.
  - getPort
```
public int getPort()
```
    Get the port of the GELF server.
    
    Returns:
    
    the port of the GELF server.
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    Get the remote address of the GELF server.
    
    Returns:
    
    the remote address of the GELF server.
  - getTransport
```
public GelfTransports getTransport()
```
    Get the transport protocol used with the GELF server.
    
    Returns:
    
    the transport protocol used with the GELF server
  - transport
```
public GelfConfiguration transport(GelfTransports transport)
```
    Set the transport protocol used with the GELF server.
    
    Parameters:
    
    transport - the transport protocol used with the GELF server
    
    Returns:
    
    this instance
  - getQueueSize
```
public int getQueueSize()
```
    Get the size of the internally used BlockingQueue.
    
    Returns:
    
    the size of the internally used queue
  - queueSize
```
public GelfConfiguration queueSize(int size)
```
    Set the size of the internally used BlockingQueue.
    
    Parameters:
    
    size - the size of the internally used queue
    
    Returns:
    
    this instance
  - isTlsEnabled
```
public boolean isTlsEnabled()
```
    Check if TLS option for the transport is enabled.
    
    Returns:
    
    true if TLS is enabled, false if disabled
  - enableTls
```
public GelfConfiguration enableTls()
```
    Enable TLS for transport.
    
    Returns:
    
    this instance
  - disableTls
```
public GelfConfiguration disableTls()
```
    Disable TLS for transport.
    
    Returns:
    
    this instance
  - getTlsTrustCertChainFile
```
public File getTlsTrustCertChainFile()
```
    Get the trust certificate chain file for the TLS connection.
    
    Returns:
    
    the trust certificate chain file
  - tlsTrustCertChainFile
```
public GelfConfiguration tlsTrustCertChainFile(File tlsTrustCertChainFile)
```
    Set the trust certificate chain file for the TLS connection.
    
    Parameters:
    
    tlsTrustCertChainFile - the trust certificate chain file
    
    Returns:
    
    this instance
  - isTlsCertVerificationEnabled
```
public boolean isTlsCertVerificationEnabled()
```
    Check if TLS certificate verification is enabled.
    
    Returns:
    
    true if enabled, false if disabled
  - enableTlsCertVerification
```
public GelfConfiguration enableTlsCertVerification()
```
    Enable TLS certificate verification for transport.
    
    Returns:
    
    this instance
  - disableTlsCertVerification
```
public GelfConfiguration disableTlsCertVerification()
```
    Disable TLS certificate verification for transport.
    
    Returns:
    
    this instance
  - getReconnectDelay
```
public int getReconnectDelay()
```
    Get the time to wait between reconnects in milliseconds.
    
    Returns:
    
    the time to wait between reconnects in milliseconds
  - reconnectDelay
```
public GelfConfiguration reconnectDelay(int reconnectDelay)
```
    Set the time to wait between reconnects in milliseconds.
    
    Parameters:
    
    reconnectDelay - the time to wait between reconnects in milliseconds
    
    Returns:
    
    this instance
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Get the connection timeout for TCP connections in milliseconds.
    
    Returns:
    
    the connection timeout for TCP connections in milliseconds
    
    See Also:
    
    ChannelOption.CONNECT_TIMEOUT_MILLIS
  - connectTimeout
```
public GelfConfiguration connectTimeout(int connectTimeout)
```
    Set the connection timeout for TCP connections in milliseconds.
    
    Parameters:
    
    connectTimeout - the connection timeout for TCP connections in milliseconds
    
    Returns:
    
    this instance
    
    See Also:
    
    ChannelOption.CONNECT_TIMEOUT_MILLIS
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    Whether Nagle's algorithm is enabled for TCP connections.
    
    Returns:
    
    true if Nagle's algorithm is being used for TCP connections
    
    See Also:
    
    ChannelOption.TCP_NODELAY
  - tcpNoDelay
```
public GelfConfiguration tcpNoDelay(boolean tcpNoDelay)
```
    Whether to use Nagle's algorithm for TCP connections.
    
    Parameters:
    
    tcpNoDelay - true if Nagle's algorithm should used for TCP connections, false otherwise
    
    Returns:
    
    this instance
    
    See Also:
    
    ChannelOption.TCP_NODELAY
  - isTcpKeepAlive
```
public boolean isTcpKeepAlive()
```
  - tcpKeepAlive
```
public GelfConfiguration tcpKeepAlive(boolean tcpKeepAlive)
```
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Get the size of the socket send buffer in bytes.
    
    Returns:
    
    the size of the socket send buffer in bytes.
    
    See Also:
    
    ChannelOption.SO_SNDBUF
  - sendBufferSize
```
public GelfConfiguration sendBufferSize(int sendBufferSize)
```
    Set the size of the socket send buffer in bytes.
    
    Parameters:
    
    sendBufferSize - the size of the socket send buffer in bytes. A value of -1 deactivates the socket send buffer.
    
    Returns:
    
    this instance
    
    See Also:
    
    ChannelOption.SO_SNDBUF
  - getMaxInflightSends
```
public int getMaxInflightSends()
```
    Get the number of max queued network operations.
    
    Returns:
    
    max number of queued network operations
    
    Since:
    
    1.4.0
  - maxInflightSends
```
public GelfConfiguration maxInflightSends(int maxInflightSends)
```
    Set the number of max queued network operations.
    
    Parameters:
    
    maxInflightSends - max number of queued network operations
    
    Returns:
    
    this instance
    
    Since:
    
    1.4.0

Class GelfConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GelfConfiguration

GelfConfiguration

GelfConfiguration

GelfConfiguration

GelfConfiguration

Method Detail

getHostname

getPort

getRemoteAddress

getTransport

transport

getQueueSize

queueSize

isTlsEnabled

enableTls

disableTls

getTlsTrustCertChainFile

tlsTrustCertChainFile

isTlsCertVerificationEnabled

enableTlsCertVerification

disableTlsCertVerification

getReconnectDelay

reconnectDelay

getConnectTimeout

connectTimeout

isTcpNoDelay

tcpNoDelay

isTcpKeepAlive

tcpKeepAlive

getSendBufferSize

sendBufferSize

getMaxInflightSends

maxInflightSends