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

Class ExchangeParams

java.lang.Object

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

All Implemented Interfaces:

VisitableConfig

public class ExchangeParams
extends Object
implements VisitableConfig

Configuration of coap exchange parameters

Field Summary

Fields

Modifier and Type	Field and Description
Float	ackRandomFactor Factor for spreading retransmission timing.
String	ackTimeout The minimum spacing time before retransmission is tried.
Float	ackTimeoutScale The back-off factor for retransmissions.
CongestionControl	congestionControl Configuration of the congestion control algorithm, if any.
Deduplicator	deduplicator The deduplicator type used to deduplicate incoming messages.
String	exchangeLifetime The time from starting to send a Confirmable message to the time when an acknowledgement is no longer expected.
String	leisure LEISURE is the period of time (in milliseconds [ms]) of the spreading of responses to a multicast request, for network congestion prevention.
String	maxAckTimeout Maximum CoAP acknowledge timeout for CON messages.
Integer	maxActivePeers The maximum number of active peers supported.
String	maxLatency The duration a datagram is expected to take from the start of its transmission to the completion of its reception.
String	maxPeerInactivityPeriod The maximum time a peer may be inactive for before it is considered stale and all state associated with it can be discarded.
String	maxResponseDelay The expected maximum response delay over all servers that the client can send a multicast request to.
Integer	maxRetransmit The maximum number of retransmissions that are attempted when no acknowledgement is received.
String	maxTransmitWait The maximum duration from the first transmission of a Confirmable message to the time when the sender gives up on receiving an acknowledgement or reset.
MidTracker	midTracker The message identity tracker used.
Integer	multicastMidBase Base for multicast MID range.
String	nonLifetime The duration from sending a Non-confirmable message to the moment its Message ID can be safely reused.
Integer	nstart Maximum number of simultaneous outstanding interactions with a peer.
boolean	strictEmptyMessageFormat When enabled empty messages that contain token, options or payload are considered a format error.
Integer	tokenSizeLimit The maximum token length (bytes).
boolean	useRandomMidStart When true the message IDs will start at a random index.

Constructor Summary

Constructors

Constructor and Description
ExchangeParams() Default exchange params used by Mule.
ExchangeParams(MidTracker midTracker) Constructor for manually constructing the exchange params.

Method Summary

Modifier and Type	Method and Description
void	accept(ConfigVisitor visitor) Accept visitor.
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

maxActivePeers

@Parameter
 @Optional(defaultValue="150000")
 @Summary(value="The maximum number of active peers supported.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer maxActivePeers

The maximum number of active peers supported. Used by udp tcp.

maxPeerInactivityPeriod

@Parameter
 @Optional(defaultValue="10m")
 @Summary(value="The maximum number time a peer may be inactive for before it is considered stale\n and all state associated with it can be discarded.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String maxPeerInactivityPeriod

The maximum time a peer may be inactive for before it is considered stale and all state associated with it can be discarded.

ackTimeout

@Parameter
 @Optional(defaultValue="2s")
 @Summary(value="The minimum spacing time before retransmission is tried.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String ackTimeout

The minimum spacing time before retransmission is tried. Used by udp transmission.

ackRandomFactor

@Parameter
 @Optional(defaultValue="1.5")
 @Summary(value="Factor for spreading retransmission timing.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Float ackRandomFactor

Factor for spreading retransmission timing. Used by udp transmission.

ackTimeoutScale

@Parameter
 @Optional(defaultValue="2.0")
 @Summary(value="The back-off factor for retransmissions. \nEvery subsequent retransmission time, spacing is enlarged using this factor.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Float ackTimeoutScale

The back-off factor for retransmissions. Every subsequent retransmission time spacing is enlarged using this factor. Used by udp transmission.

maxRetransmit

@Parameter
 @Optional(defaultValue="4")
 @Summary(value="The maximum number of retransmissions that are attempted \nwhen no acknowledgement is received.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer maxRetransmit

The maximum number of retransmissions that are attempted when no acknowledgement is received. Used by udp transmission.

maxAckTimeout

@Parameter
 @Optional(defaultValue="1m")
 @Summary(value="Maximum CoAP acknowledge timeout for CON messages.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String maxAckTimeout

Maximum CoAP acknowledge timeout for CON messages. Not RFC7252 compliant. Used by udp.

exchangeLifetime

@Parameter
 @Optional(defaultValue="247s")
 @Summary(value="The duration between starting to send a Confirmable message \nto the moment when an acknowledgement is no longer expected.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String exchangeLifetime

The time from starting to send a Confirmable message to the time when an acknowledgement is no longer expected. Default values is 247 seconds.

nonLifetime

@Parameter
 @Optional(defaultValue="145s")
 @Summary(value="The duration from sending a Non-confirmable message to the moment when its Message ID can be safely reused.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String nonLifetime

The duration from sending a Non-confirmable message to the moment its Message ID can be safely reused. Default values is 145000 (145 seconds). Used by udp transmission derived.

maxLatency

@Parameter
 @Optional(defaultValue="100s")
 @Summary(value="The maximum duration a datagram is expected to take from the start \n of its transmission to the completion of its reception.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String maxLatency

The duration a datagram is expected to take from the start of its transmission to the completion of its reception. Default values is 100 (100 seconds). See RFC7252, 4.8.2. Time Values Derived from Transmission Parameters. Used by udp transmission derived.

maxTransmitWait

@Parameter
 @Optional(defaultValue="93s")
 @Summary(value="The maximum duration from the first transmission of \na Confirmable message to the time when the sender gives up on \nreceiving an acknowledgement or reset.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String maxTransmitWait

The maximum duration from the first transmission of a Confirmable message to the time when the sender gives up on receiving an acknowledgement or reset. Default value is 93 seconds. See RFC7252, 4.8.2. Time Values Derived from Transmission Parameters. Used by udp transmission derived.

maxResponseDelay

@Parameter
 @Optional(defaultValue="250s")
 @Summary(value="The expected maximum response delay over all servers \nthat the client can send a multicast request to.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String maxResponseDelay

The expected maximum response delay over all servers that the client can send a multicast request to. See RFC7390, 2.5. Request and Response Model Default values is 250 seconds). Used by udp multicast.

nstart

@Parameter
 @Optional(defaultValue="1")
 @Summary(value="Maximum number of simultaneous outstanding interactions with a peer. \n(rfc7252 specifies default=1)")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer nstart

Maximum number of simultaneous outstanding interactions with a peer. (rfc7252 specifies default=1) Used by udp transmission.

tokenSizeLimit

@Parameter
 @Optional(defaultValue="8")
 @Summary(value="The maximum token length [bytes].")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer tokenSizeLimit

The maximum token length (bytes). Used by udp tcp.

multicastMidBase

@Parameter
 @Optional(defaultValue="65000")
 @Summary(value="Base for multicast MID range. Multicast requests use MIDs in the range [base...65536).\nA negative or zero value disables multicast requests.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Integer multicastMidBase

Base for multicast MID range. Multicast requests use MIDs in the range [base...65536). A negative or zero value disables multicast requests. Used by udp and multicast.

leisure

@Parameter
 @Optional(defaultValue="5s")
 @Summary(value="The spreading time of responses to a multicast request, \nfor network congestion prevention.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public String leisure

LEISURE is the period of time (in milliseconds [ms]) of the spreading of responses to a multicast request, for network congestion prevention. Used by udp transmission- multicast.

See Also:

IETF RFC 7252 - 8.2. Request/Response Layer

strictEmptyMessageFormat

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="When enabled empty messages that contain token, options or payload are considered a format error.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean strictEmptyMessageFormat

When enabled empty messages that contain token, options or payload are considered a format error. Used by udp tcp.

useRandomMidStart

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="When true the message IDs will start at a random index. Otherwise the first message ID returned will be 0.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public boolean useRandomMidStart

When true the message IDs will start at a random index. Otherwise the first message ID returned will be 0. Used by udp.

midTracker

@Parameter
 @Optional
 @NullSafe(defaultImplementingType=GroupedMidTracker.class)
 @Summary(value="The message identity tracker strategy to use.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public MidTracker midTracker

The message identity tracker used. The tracker maintains the administration of message id's uses in the CoAP exchanges. These use different strategies like maintaining a map of individual entries or use groups where id's get cleaned by group. Supported values are NULL, GROUPED, or MAPBASED. Used by udp.

deduplicator

@Parameter
 @Optional
 @Summary(value=" The deduplicator type used to deduplicate incoming messages.")
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public Deduplicator deduplicator

The deduplicator type used to deduplicate incoming messages. Available deduplicators are MARK_AND_SWEEP, PEERS_MARK_AND_SWEEP and CROP_ROTATION. Used by udp.

congestionControl

@Parameter
 @Optional
 @Expression(value=NOT_SUPPORTED)
 @ParameterDsl(allowReferences=false)
public CongestionControl congestionControl

Configuration of the congestion control algorithm, if any.

Constructor Detail

ExchangeParams

public ExchangeParams()

Default exchange params used by Mule. Containing mandatory and Nullsafe params are set by Mule.

ExchangeParams

public ExchangeParams(MidTracker midTracker)

Constructor for manually constructing the exchange params.

Parameters:

midTracker - The manually set MidTracker.

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()