net.sf.eBus.client.sysmessages

Class PauseRequest

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ESystemMessage

net.sf.eBus.client.sysmessages.AbstractLogonMessage

net.sf.eBus.client.sysmessages.PauseRequest

All Implemented Interfaces:

Serializable

public final class PauseRequest
extends AbstractLogonMessage
implements Serializable

This message is sent to request a connection pause with the remote eBus application. A pause means that while the connection is down, both sides will maintain the other side's advertisements and queue up messages for future delivery. The far-end eBus application will respond with a PauseReply which specifies whether a pause is accepted and, if yes, the pause time and maximum backlog size it supports. These values may be the same as or less than this message's suggested values; the response values will never be greater than what is requested.

Contrast this message with a LogoffMessage which tears down a connection completely.

Author:

Charles W. Rapp

See Also:

PauseReply, LogoffMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PauseRequest.Builder Class used to create PauseRequest messages.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
EConfigure.DiscardPolicy	discardPolicy Specifies how the far-end should discard messages if and when maximumBacklogSize is reached.
int	maximumBacklogSize Requesting the far-end store up to this many un-delivered messages before beginning to discard messages.
Duration	pauseTime Requesting a connection pause lasting for this duration.

Fields inherited from class net.sf.eBus.client.sysmessages.AbstractLogonMessage

eid

Fields inherited from class net.sf.eBus.messages.ESystemMessage

SYSTEM_SUBJECT

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Method Summary

Modifier and Type	Method and Description
static PauseRequest.Builder	builder() Returns a new instance of the PauseRequest message builder.
String	toString() Returns a human-readable text version of this message.

Methods inherited from class net.sf.eBus.client.sysmessages.AbstractLogonMessage

equals, hashCode

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

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

Field Detail

pauseTime

public final Duration pauseTime

Requesting a connection pause lasting for this duration. The far-end may not accept this time and require a shorter pause time

maximumBacklogSize

public final int maximumBacklogSize

Requesting the far-end store up to this many un-delivered messages before beginning to discard messages. Which messages are to be discarded is based on the discardPolicy. Please note that is size is a suggestion. The far-end response may specify smaller backlog size.

discardPolicy

public final EConfigure.DiscardPolicy discardPolicy

Specifies how the far-end should discard messages if and when maximumBacklogSize is reached.

Method Detail

toString

public String toString()

Description copied from class: AbstractLogonMessage

Returns a human-readable text version of this message.

Overrides:

toString in class AbstractLogonMessage

Returns:

text version of this message.

builder

public static PauseRequest.Builder builder()

Returns a new instance of the PauseRequest message builder.

Returns:

message builder instance.