com.neeve.aep.event
Class AepClientConnectedEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.aep.event.AepClientConnectedEvent

All Implemented Interfaces:

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

public final class AepClientConnectedEvent
extends Event

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

Threading:

This class is safe for concurrent access by multiple threads.

This event is used by the 'server' bus to notify an application that one of it's clients has connected to the 'server' and is bound to the application. The client is identified using the message channel used to communicate with it. The name of the channel is the name of the connected client. The 'server' bus automatically joins the channel to enable messages from the client to the dispatched to the application.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepClientConnectedEvent	create(MessageBusBinding binding, MessageChannel channel) Create a new (initialized) client connected event.
static Event	create(Properties props) Create a new (uninitialized) client connected event.
MessageChannel	getClient() Get the client that just connected 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 connected event.

This method instantiates a new client connected event object. The method is for use by the event factory to instantiate new client connected 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 connected event object even if there are eligible event objects available in the event type's pool.

create

public static AepClientConnectedEvent create(MessageBusBinding binding,
                                             MessageChannel channel)

Create a new (initialized) client connected event.

Parameters:

binding - The binding from where this event originated

channel - The channel that identifies the client that connected.

This method instantiates and initializes a client connected event. The method uses the event factory to instantiate a new client connected 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 connected 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