com.neeve.sma.event

Class BusCongestedEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.sma.event.BusCongestedEvent

All Implemented Interfaces:

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

public final class BusCongestedEvent
extends Event

Event notifying sender of bus congestion.

Threading:

This class is safe for concurrent access by multiple threads.

This event is dispatched when the bus is congested due to the sender's high send rate. The sender should throttle back its send rate in response to this event.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
static BusCongestedEvent	create(MessageBusBinding binding) Create a new (initialized) bus congested event.
static Event	create(Properties props) Create a new (uninitialized) bus congested event.
String	toString() Get a string representation of a message 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) bus congested event.

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

create

public static BusCongestedEvent create(MessageBusBinding binding)

Create a new (initialized) bus congested event.

Parameters:

binding - The binding from where this event originated

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

toString

public final String toString()

Get a string representation of a message event.

Overrides:

toString in class Event