com.neeve.aep
Class AepSendEvent

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

All Implemented Interfaces:

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

public final class AepSendEvent
extends Event

Event used to trigger sends for unsolicited message sends.

Threading:

This class is safe for concurrent access by multiple threads.

This event is for private use by the AEP engine. An AEP user does not have any direct use of this event.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepSendEvent	create(MessageChannel channel, IRogMessage message) Create a new (initialized) send event.
static Event	create(Properties props) Create a new (uninitialized) send event.
IRogMessage	getMessage() Get the outbound message.
MessageChannel	getMessageChannel() Get the outbound channel.
String	toString() Get a string representation of a send event.

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) send event.

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

create

public static AepSendEvent create(MessageChannel channel,
                                  IRogMessage message)

Create a new (initialized) send event.

Parameters:

channel - The channel through where the message is to be sent.

message - The message to send.

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

getMessageChannel

public final MessageChannel getMessageChannel()

Get the outbound channel.

Threading:

This method is safe for concurrent access by multiple threads.

getMessage

public final IRogMessage getMessage()

Get the outbound message.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public final String toString()

Get a string representation of a send event.

Overrides:

toString in class Event