com.hivemq.spi.services.configuration.entity

Interface Listener

All Known Implementing Classes:

TcpListener, TlsTcpListener, TlsWebsocketListener, WebsocketListener

public interface Listener

A marker interface for a listener. Any listener implementation must implement this interface.

Author:

Dominik Obermaier, Christoph Schaebel, Georg Held

See Also:

TcpListener, TlsTcpListener, WebsocketListener, TlsWebsocketListener

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()

Method Detail

getPort

int getPort()

Returns:

the port of the listener

getBindAddress

String getBindAddress()

Returns:

the bind address of a listener

readableName

String readableName()

Returns:

the human readable, name of the listener

isProxyProtocolSupported

boolean isProxyProtocolSupported()

Returns:

if the PROXY protocol is supported by this listener

Since:

3.2

getSocketOptionsProperties

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

Returns:

an Optional of SocketOptionsProperties of this listener

getConnectOverloadProtectionProperties

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

Returns:

an Optional of ConnectOverloadProtectionProperties of this listener

getClientWriteBufferProperties

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

Returns:

an Optional of ClientWriteBufferProperties of this listener