com.hivemq.spi.services.configuration.entity

Class TcpListener

java.lang.Object

com.hivemq.spi.services.configuration.entity.TcpListener

All Implemented Interfaces:

Listener

Direct Known Subclasses:

TlsTcpListener

@Immutable
public class TcpListener
extends Object
implements Listener

A listener which allows to listen to MQTT traffic via TCP

Since:

3.0

Author:

Dominik Obermaier, Christoph Schaebel, Georg Held

Constructor Summary

Constructors

Constructor and Description
TcpListener(int port, String bindAddress) Creates a new TCP listener which listens to a specific port and bind address
TcpListener(int port, String bindAddress, boolean proxyProtocolSupported) Creates a new TCP listener which listens to a specific port, bind address and proxy setting
TcpListener(int port, String bindAddress, boolean proxyProtocolSupported, SocketOptionsProperties socketOptionsProperties, ConnectOverloadProtectionProperties connectOverloadProtectionProperties, ClientWriteBufferProperties clientWriteBufferProperties) Creates a new TCP listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties

Method Summary

Methods

Modifier and Type	Method and Description
String	getBindAddress()
com.google.common.base.Optional<ClientWriteBufferProperties>	getClientWriteBufferProperties()
com.google.common.base.Optional<ConnectOverloadProtectionProperties>	getConnectOverloadProtectionProperties()
int	getPort()
com.google.common.base.Optional<SocketOptionsProperties>	getSocketOptionsProperties()
boolean	isProxyProtocolSupported()
String	readableName()

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpListener

public TcpListener(int port,
           @NotNull
           String bindAddress)

Creates a new TCP listener which listens to a specific port and bind address

Parameters:

port - the port

bindAddress - the bind address

TcpListener

public TcpListener(int port,
           @NotNull
           String bindAddress,
           boolean proxyProtocolSupported)

Creates a new TCP listener which listens to a specific port, bind address and proxy setting

Parameters:

port - the port

bindAddress - the bind address

proxyProtocolSupported - if this listener should be able to utilize the PROXY protocol

TcpListener

public TcpListener(int port,
           @NotNull
           String bindAddress,
           boolean proxyProtocolSupported,
           @Nullable
           SocketOptionsProperties socketOptionsProperties,
           @Nullable
           ConnectOverloadProtectionProperties connectOverloadProtectionProperties,
           @Nullable
           ClientWriteBufferProperties clientWriteBufferProperties)

Creates a new TCP listener which listens to a specific port, bind address, proxy setting, socket options, overload protection and write buffer properties

Parameters:

port - the port

bindAddress - the bind address

proxyProtocolSupported - if this listener should be able to utilize the PROXY protocol

socketOptionsProperties - a configuration of SocketOptionsProperties for this listener or null to use the default

connectOverloadProtectionProperties - a configuration of ConnectOverloadProtectionProperties for this listener or null to deactivate connect overload protection

clientWriteBufferProperties - a configuration of ClientWriteBufferProperties for this listener or null to use the default

Method Detail

getPort

public int getPort()

Specified by:

getPort in interface Listener

Returns:

the port of the listener

getBindAddress

public String getBindAddress()

Specified by:

getBindAddress in interface Listener

Returns:

the bind address of a listener

readableName

public String readableName()

Specified by:

readableName in interface Listener

Returns:

the human readable, name of the listener

isProxyProtocolSupported

public boolean isProxyProtocolSupported()

Specified by:

isProxyProtocolSupported in interface Listener

Returns:

if the PROXY protocol is supported by this listener

getSocketOptionsProperties

public com.google.common.base.Optional<SocketOptionsProperties> getSocketOptionsProperties()

Specified by:

getSocketOptionsProperties in interface Listener

Returns:

an Optional of SocketOptionsProperties of this listener

getConnectOverloadProtectionProperties

public com.google.common.base.Optional<ConnectOverloadProtectionProperties> getConnectOverloadProtectionProperties()

Specified by:

getConnectOverloadProtectionProperties in interface Listener

Returns:

an Optional of ConnectOverloadProtectionProperties of this listener

getClientWriteBufferProperties

public com.google.common.base.Optional<ClientWriteBufferProperties> getClientWriteBufferProperties()

Specified by:

getClientWriteBufferProperties in interface Listener

Returns:

an Optional of ClientWriteBufferProperties of this listener