com.neeve.aep.event

Class AepClientDisconnectedEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.aep.event.AepClientDisconnectedEvent

All Implemented Interfaces:

IEvent, UtlPool.Item<Event>, UtlReferenceTracker.HasReferenceTracker

public final class AepClientDisconnectedEvent
extends Event

Event notifying an AEP application that one of it's clients has disconnected.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched by a 'server' bus to notify that a directly connected client has disconnected.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
static AepClientDisconnectedEvent	create(MessageBusBinding binding, MessageChannel channel) Create a new (initialized) client disconnected event.
static Event	create(Properties props) Create a new (uninitialized) client disconnected event.
MessageChannel	getClient() Get the client that just disconnected to the server.
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.Event

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getOfferTs, getPollTs, getPool, getRemainingTime, getScheduledTime, getSource, getType, init, isEndOfBatch, isHandled, owners, referenceTracker, setAcknowledger, setAttachment, setDelay, setDispatchTime, setEndOfBatch, setHandled, setPool, setScheduledTime, setSource

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Event create(Properties props)

Create a new (uninitialized) client disconnected event.

This method instantiates a new client disconnected event object. The method is for use by the event factory to instantiate new client disconnected events. The method should not be used directly by the user since the method bypasses any event pooling i.e. it creates a new client disconnected event object even if there are eligible event objects available in the event type's pool.

create

public static AepClientDisconnectedEvent create(MessageBusBinding binding,
                                MessageChannel channel)

Create a new (initialized) client disconnected event.

Parameters:

binding - The binding from where this event originated

channel - The channel that identifies the client that disconnected.

This method instantiates and initializes a client disconnected event. The method uses the event factory to instantiate a new client disconnected evemt (the factory recycles objects through the event type's object pool is configured for the type) and then initializes it with the supplied parameters.

getClient

public final MessageChannel getClient()

Get the client that just disconnected to the server.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class Event