com.neeve.aep.event
Class AepClientPacketEvent

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

All Implemented Interfaces:

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

public final class AepClientPacketEvent
extends Event

Event notifying an AEP application of receipt of a packet.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched to an application when a packet is received from an application's client.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepClientPacketEvent	create(MessageBusBinding binding, MessageChannel client, PktPacket packet) Create a new (initialized) client packet event.
static Event	create(Properties props) Create a new (uninitialized) client packet event.
MessageChannel	getClient() Get the client that sent the packet.
PktPacket	getPacket() Get the packet.
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 packet event.

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

create

public static AepClientPacketEvent create(MessageBusBinding binding,
                                          MessageChannel client,
                                          PktPacket packet)

Create a new (initialized) client packet event.

Parameters:

binding - The 'server' binding from where this event originated.

client - The client that sent the packet.

packet - The received packet.

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

Threading:

This method is safe for concurrent access by multiple threads.

getPacket

public final PktPacket getPacket()

Get the packet.

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