com.neeve.aep.event

Class AepSendStabilityEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.aep.event.AepSendStabilityEvent

All Implemented Interfaces:

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

public final class AepSendStabilityEvent
extends Event

Event used to inform unsolicited senders that the unsolicited send has been stabilized.

Threading:

This class is safe for concurrent access by multiple threads.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
static AepSendStabilityEvent	create(MessageChannel channel, MessageView message, Exception status) Create a new (initialized) send event.
MessageView	getMessage() Get the outbound message.
MessageChannel	getMessageChannel() Get the outbound channel.
Exception	getStatus() Get the stabilization status.
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 AepSendStabilityEvent create(MessageChannel channel,
                           MessageView message,
                           Exception status)

Create a new (initialized) send event.

Parameters:

channel - The channel through which the message was to be sent.

message - The message to send.

status - An exception indicated that send completed with an error.

This method instantiates and initializes a send stability 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 MessageView getMessage()

Get the outbound message.

Threading:

This method is safe for concurrent access by multiple threads, though the message is not safe to modify and the caller must not hold on to the message beyond the scope of the event handler in which this event is dispatched.

getStatus

public final Exception getStatus()

Get the stabilization status.

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