com.neeve.client
Class ClientConnectionPoolEvents

java.lang.Object
  com.neeve.client.ClientConnectionPoolEvents

public class ClientConnectionPoolEvents
extends Object

Class containing client connection pool event definitions.

This class contains event type and associated structure definitions for events dispatched by client connection pools.

Nested Class Summary

static class	ClientConnectionPoolEvents.CongestionEventData Data object for the EVENT_CONGESTION event.
static class	ClientConnectionPoolEvents.FailEventData Data object for the EVENT_FAILURE event.

Field Summary

static int	EVENT_CONGESTION Indicates flow congestion.
static int	EVENT_FAILURE Indicates that a client connection pool has failed.
static int	EVENT_FLUSH_COMPLETION Indicates flush completion.
static int	EVENT_MESSAGE Indicates the receipt of a message.
static int	EVENT_MESSAGE_LIST Indicates the receipt of a message list.
static int	EVENT_PACKET Indicates the receipt of a packet.
static int	EVENT_PACKET_LIST Indicates the receipt of a packet list.

Constructor Summary

ClientConnectionPoolEvents()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_PACKET

public static final int EVENT_PACKET

Indicates the receipt of a packet.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a client connection pool upon receipt of a packet from a server.

The event data object for this event is PktPacket.

EVENT_PACKET_LIST

public static final int EVENT_PACKET_LIST

Indicates the receipt of a packet list.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a client connection pool upon receipt of a batch of packets from a server.

The event data object for this event is UtlList.

EVENT_MESSAGE

public static final int EVENT_MESSAGE

Indicates the receipt of a message.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a client connection pool upon receipt of a message from a server.

The event data object for this event is ILnkMessage.

EVENT_MESSAGE_LIST

public static final int EVENT_MESSAGE_LIST

Indicates the receipt of a message list.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a client connection pool upon receipt of a batch of messages from a server.

The event data object for this event is UtlList.

EVENT_CONGESTION

public static final int EVENT_CONGESTION

Indicates flow congestion.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a connection pool to notify of congestion in a message flow. The user should use these events to throttle back the publish rate for the flow that is congested (most pool implementation supply inherent mechanisms to do so automatically. This event is only for users who switch off automatic congestion management and want to handle congestion events themselves). Note that there are no congestion abatement events that are dispatched. Therefore, the user should implement some judicious algorithm that gradually ramps up the publish rate as long as congestion events are not notified and scale back publish rate when congestion is experienced. A good algorithm to use is to additively ramp up multiplicatively ramp down publish rates.

The event data object for this event is ClientConnectionPoolEvents.CongestionEventData.

EVENT_FLUSH_COMPLETION

public static final int EVENT_FLUSH_COMPLETION

Indicates flush completion.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a connection pool to notify of the completion of an asynchronous flush.

The event data object for this event is ILnkPeerEndpoint.AsynchronousFlushContext.

EVENT_FAILURE

public static final int EVENT_FAILURE

Indicates that a client connection pool has failed.

See Also:

Constant Field Values

Threading:

This event can be dispatched any thread of the pool's choosing. See the concrete pool implementation documentation for details on which threads dispatch these event.

This event is dispatched by a client connection when it detects a failure severe enough to stop operations. The pool's state is transitioned to ClientConnectionPool.State.FAILED before this event is dispatched.

The event data associated with this event is of type ClientConnectionPoolEvents.FailEventData

Constructor Detail

ClientConnectionPoolEvents

public ClientConnectionPoolEvents()