nl.teslanet.mule.connectors.coap.api.config

Class SocketParams

java.lang.Object

nl.teslanet.mule.connectors.coap.api.config.SocketParams

All Implemented Interfaces:

VisitableConfig

public class SocketParams
extends Object
implements VisitableConfig

Socket configuration parameters.

Field Summary

Fields

Modifier and Type	Field and Description
String	bindToHost The hostname or IP address the CoAP endpoint binds to.
Integer	bindToPort The port the CoAP endpoint binds to.
Integer	receiveBuffer Receive buffer size [bytes].
boolean	reuseAddress Reuse address when true.
Integer	sendBuffer Send buffer size [bytes].

Constructor Summary

Constructors

Constructor and Description
SocketParams()

Method Summary

Modifier and Type	Method and Description
void	accept(ConfigVisitor visitor) Accept visitor.

Methods inherited from class java.lang.Object

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

Field Detail

bindToHost

@Parameter
 @Optional
 @Summary(value="The hostname or IP address the CoAP endpoint binds to. If empty anyLocalAddress is used (typically 0.0.0.0 or ::0)")
 @Example(value="0.0.0.0")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String bindToHost

The hostname or IP address the CoAP endpoint binds to. If none is given anyLocalAddress is used (typically 0.0.0.0 or ::0)

bindToPort

@Parameter
 @Optional
 @Summary(value="The port the CoAP endpoint binds to.\nWhen empty a free ephemeral port will be used, which is usual for client endpoints.\nA server endpoint usually binds to one of the standard CoAP ports 5683 (coap) and 5684 (coaps), or to another predetermined port value.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer bindToPort

The port the CoAP endpoint binds to. When empty a free ephemeral port will be used, which is usual for client endpoints. A server endpoint usually binds to one of the standard CoAP ports 5683 (coap) and 5684 (coaps), or to another predetermined port value.

receiveBuffer

@Parameter
 @Optional
 @Summary(value="Receive buffer size [bytes]. \nThe size is os-defined by default and must be at least 64 bytes.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer receiveBuffer

Receive buffer size [bytes].

sendBuffer

@Parameter
 @Optional
 @Summary(value="Send buffer size [bytes]. \nThe size is os-defined by default and must be at least 64 bytes.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer sendBuffer

Send buffer size [bytes].

reuseAddress

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="Reuse address when true.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean reuseAddress

Reuse address when true.

Constructor Detail

SocketParams

public SocketParams()

Method Detail

accept

public void accept(ConfigVisitor visitor)
            throws ConfigException

Accept visitor.

Specified by:

accept in interface VisitableConfig

Parameters:

visitor - The visitor of the configuration object.

Throws:

ConfigException - When the visit was not successful.