net.sf.eBus.config

Class EConfigure.PauseConfig

java.lang.Object

net.sf.eBus.config.EConfigure.PauseConfig

Enclosing class:

EConfigure

public static final class EConfigure.PauseConfig
extends Object

If a remote connection may be paused, then this is the allowed pause configuration. When defined for a connection acceptor, only the pause duration and maximum backlog size properties are used. A connection initiator has all properties used.

When a connection is paused, the actual connection is dropped but all the subscriptions and advertisements are kept in place. That means that system and application messages destined for the other side are queued, ready for transmit when the connection is resumed. While all system messages are queued, the number of queued application messages may be limited. When that limit is reached, further application messages are discard as per the configured EConfigure.DiscardPolicy.

This feature is targeted for eBus-based applications running on mobile devices. Such devices cannot maintain active connections for long without overheating and draining the battery.

Method Summary

Modifier and Type	Method and Description
EConfigure.DiscardPolicy	discardPolicy() Returns the message discard policy used when the maximum message backlog size is breached.
Duration	duration() Returns the maximum allowed pause duration.
Duration	idleTime() Returns the amount of time wherein no messages are sent or received on the connection before the connection is paused.
int	maxBacklogSize() Returns the maximum allowed message backlog size.
Duration	maxConnectTime() Returns the maximum time a connection may remain up before being paused.
int	resumeOnQueueLimit() Returns the transmit queue limit which triggers an automatic client connection resumption.
String	toString() Returns the pause configuration as text.

Methods inherited from class java.lang.Object

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

Method Detail

toString

public String toString()

Returns the pause configuration as text.

Overrides:

toString in class Object

Returns:

textual representation of the pause configuration.

duration

public Duration duration()

Returns the maximum allowed pause duration.

Returns:

pause duration.

maxBacklogSize

public int maxBacklogSize()

Returns the maximum allowed message backlog size.

Returns:

message backlog size.

discardPolicy

public EConfigure.DiscardPolicy discardPolicy()

Returns the message discard policy used when the maximum message backlog size is breached.

Returns:

message discard policy.

idleTime

public Duration idleTime()

Returns the amount of time wherein no messages are sent or received on the connection before the connection is paused.

Returns:

connection idle time.

maxConnectTime

public Duration maxConnectTime()

Returns the maximum time a connection may remain up before being paused. Note that this pausing is irrespective of the message arrival or departure.

Returns:

maximum connection time between pauses.

resumeOnQueueLimit

public int resumeOnQueueLimit()

Returns the transmit queue limit which triggers an automatic client connection resumption. If zero is returned, then this trigger is disabled.

Returns:

resume on reaching transmit queue limit.