com.neeve.link
Class LnkEvents

java.lang.Object
  com.neeve.link.LnkEvents

public final class LnkEvents
extends Object

Class containing link event definitions.

This class contains event type and associated structure definitions for events applicable to all link implementations.

Nested Class Summary

static class	LnkEvents.ConnectAcceptCompleteEventData Data object for the EVENT_CONNECT_COMPLETE and the EVENT_ACCEPT_COMPLETE event types.
static class	LnkEvents.ContinuousAcceptCompleteEventData Data object for the EVENT_CONTINUOUS_ACCEPT_COMPLETE event.
static class	LnkEvents.ContinuousConnectCompleteEventData Data object for the EVENT_CONTINUOUS_CONNECT_COMPLETE event.

Field Summary

static short	COMMON_BEGIN Event type block allocations start here
static short	COMMON_MAX_COUNT
static int	EVENT_ACCEPT_COMPLETE Indicates the completion of a link accept request.
static int	EVENT_CLOSURE Indicates the completion of the closure of a link connection.
static int	EVENT_CONNECT_COMPLETE Indicates the completion of a link connect request.
static int	EVENT_CONTINUOUS_ACCEPT_COMPLETE Indicates the completion of a link continuous accept request.
static int	EVENT_CONTINUOUS_CONNECT_COMPLETE Indicates the completion of a link continuous connect request.
static int	EVENT_FAILURE Indicates the failure of a link connection.
static int	EVENT_FLUSH_COMPLETE Indicates the completion of an asynchronous endpoint flush.
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.
static int	EVENT_REQUEST_COMPLETE Indicates the receipt of all replies for a request in a request-reply exchange.
static short	FABRIC_BEGIN
static short	FABRIC_MAX_COUNT
static short	FUC_BEGIN
static short	FUC_MAX_COUNT
static short	LOCAL_BEGIN
static short	LOCAL_MAX_COUNT
static short	MULTI_BEGIN
static short	MULTI_MAX_COUNT
static short	NETWORK_BEGIN
static short	NETWORK_MAX_COUNT
static short	SERVER_BEGIN
static short	SERVER_MAX_COUNT

Constructor Summary

LnkEvents()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_BEGIN

public static final short COMMON_BEGIN

Event type block allocations start here

See Also:

Constant Field Values

COMMON_MAX_COUNT

public static final short COMMON_MAX_COUNT

See Also:

Constant Field Values

LOCAL_BEGIN

public static final short LOCAL_BEGIN

See Also:

Constant Field Values

LOCAL_MAX_COUNT

public static final short LOCAL_MAX_COUNT

See Also:

Constant Field Values

NETWORK_BEGIN

public static final short NETWORK_BEGIN

See Also:

Constant Field Values

NETWORK_MAX_COUNT

public static final short NETWORK_MAX_COUNT

See Also:

Constant Field Values

MULTI_BEGIN

public static final short MULTI_BEGIN

See Also:

Constant Field Values

MULTI_MAX_COUNT

public static final short MULTI_MAX_COUNT

See Also:

Constant Field Values

FABRIC_BEGIN

public static final short FABRIC_BEGIN

See Also:

Constant Field Values

FABRIC_MAX_COUNT

public static final short FABRIC_MAX_COUNT

See Also:

Constant Field Values

FUC_BEGIN

public static final short FUC_BEGIN

See Also:

Constant Field Values

FUC_MAX_COUNT

public static final short FUC_MAX_COUNT

See Also:

Constant Field Values

SERVER_BEGIN

public static final short SERVER_BEGIN

See Also:

Constant Field Values

SERVER_MAX_COUNT

public static final short SERVER_MAX_COUNT

See Also:

Constant Field Values

EVENT_CONNECT_COMPLETE

public static final int EVENT_CONNECT_COMPLETE

Indicates the completion of a link connect request.

This event is dispatched by a link client endpoint upon completion of a connection establishment request. The event data for this event is an object of type LnkEvents.ConnectAcceptCompleteEventData

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of the dispatcher provided to the client endpoint when the connection establishment was initiated.

EVENT_ACCEPT_COMPLETE

public static final int EVENT_ACCEPT_COMPLETE

Indicates the completion of a link accept request.

This event is dispatched by a link server endpoint upon acceptance of a connection request from a client endpoint. The event data for this event is an object of type LnkEvents.ConnectAcceptCompleteEventData

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of the dispatcher provided to the server endpoint when the listen for incoming connection requests was initiated.

EVENT_CONTINUOUS_CONNECT_COMPLETE

public static final int EVENT_CONTINUOUS_CONNECT_COMPLETE

Indicates the completion of a link continuous connect request.

This event is dispatched by a link continuous connector upon completion of a connection establishment request. The event data for this event is an object of type LnkEvents.ContinuousConnectCompleteEventData

See Also:

Constant Field Values

Threading:

These events will always be dispatched by the owner thread of the dispatcher provided to the connector when it was created.

EVENT_CONTINUOUS_ACCEPT_COMPLETE

public static final int EVENT_CONTINUOUS_ACCEPT_COMPLETE

Indicates the completion of a link continuous accept request.

This event is dispatched by a link continuous acceptor upon acceptance of an connection request from a client endpoint. The event data for this event is an object of type LnkEvents.ContinuousAcceptCompleteEventData

See Also:

Constant Field Values

Threading:

These events will always be dispatched by the owner thread of the dispatcher provided to the continuous acceptor when the acceptor was started.

EVENT_PACKET

public static final int EVENT_PACKET

Indicates the receipt of a packet.

This event is dispatched by a link peer endpoint upon receipt of a packet. The event data for this event is an object of type PktPacket

Pooling and Packet Ownership

It is the responsibility of the handler to call PktPacket.dispose() when done with the packet, the peer endpoint passes ownership to the handler.

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of one of the dispatcher assigned to the packet receipt machinery of the peer endpoint.

EVENT_PACKET_LIST

public static final int EVENT_PACKET_LIST

Indicates the receipt of a packet list.

This event is dispatched by a link peer endpoint upon receipt of a set of packets. The event data for this event is an object of type UtlList with each element of the list of type PktPacket

Pooling and Packet Ownership

It is the responsibility of the handler to call PktPacket.dispose() when done with the packets, the peer endpoint passes ownership to the handler.

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of one of the dispatcher assigned to the packet receipt machinery of the peer endpoint.

EVENT_FLUSH_COMPLETE

public static final int EVENT_FLUSH_COMPLETE

Indicates the completion of an asynchronous endpoint flush.

This event is dispatched by a link peer endpoint upon completion of an asynchronousl flush. The event data for this event is an object of type ILnkPeerEndpoint.AsynchronousFlushContext

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of the dispatcher provided to the peer endpoint when the flush was initiated.

EVENT_FAILURE

public static final int EVENT_FAILURE

Indicates the failure of a link connection.

This event is dispatched by a link peer endpoint upon when it has detected that the remote peer endpoint is no longer reachable. The event data for this event is an object of type Exception

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of one of the dispatcher assigned to the packet receipt machinery of the peer endpoint.

EVENT_CLOSURE

public static final int EVENT_CLOSURE

Indicates the completion of the closure of a link connection.

This event is reserved for private use between LnkPeerEndpoint and the link type endpoint implementation that is wraps. This event is never dispatched to the user of a peer endpoint.

See Also:

Constant Field Values

EVENT_REQUEST_COMPLETE

public static final int EVENT_REQUEST_COMPLETE

Indicates the receipt of all replies for a request in a request-reply exchange.

This event is dispatched by a link sender to indicate to the caller that all replies for a pipelined request have been received. The event data for this event is an object of type LnkRequest

See Also:

Constant Field Values

EVENT_MESSAGE

public static final int EVENT_MESSAGE

Indicates the receipt of a message.

This event is dispatched by a link peer endpoint upon receipt of a packet that has been converted to a message via a registered message factory. The event data for this event is an object of type ILnkMessage

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of one of the dispatcher assigned to the packet receipt machinery of the peer endpoint.

EVENT_MESSAGE_LIST

public static final int EVENT_MESSAGE_LIST

Indicates the receipt of a message list.

This event is dispatched by a link peer endpoint upon receipt of a set of contiguous packets converted to a set of messages. The event data for this event is an object of type UtlList with each element of the list of type ILnkMessage

See Also:

Constant Field Values

Threading:

This event will always be dispatched by the owner thread of one of the dispatcher assigned to the packet receipt machinery of the peer endpoint.

Constructor Detail

LnkEvents

public LnkEvents()