com.neeve.link
Class LnkHandshaker.CompletionData

java.lang.Object
  com.neeve.link.LnkHandshaker.CompletionData

Enclosing class:

LnkHandshaker

public final class LnkHandshaker.CompletionData
extends Object

Class contaning the handshake completion data

Field Summary

boolean	flgReadOperationalOnStart Indicates whether the read was operational on the handshake link's tree when the handshake was initiated.
com.neeve.link.LnkHandshaker.State	initialState The initial state of the handshake.
com.neeve.util.UtlList	overflowPacketList The oevrflow packet list.
PktPacket	reply The sent/received reply packet.
PktPacket	request The sent/received request packet.
Exception	status The handshake completion status.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

initialState

public final com.neeve.link.LnkHandshaker.State initialState

The initial state of the handshake.

This field contains the initial state of the handshake. The user should use this information to understand to deduce whether the request and reply packets in this class were sent or received during the handshake.

overflowPacketList

public final com.neeve.util.UtlList overflowPacketList

The oevrflow packet list.

During the handshake, the handshaker may have received packets that do not apply to the handshake. This list contains such packets. The user should process these packets as if they were received subsequent to a successful handshake.

request

public PktPacket request

The sent/received request packet.

This field contains the request packet exchanged during the handshake. The request was sent to the handshaking peer in case the handshake was kicked off in the State#CONNECTED state. Otherwise, it was received from the handshaking peer.

reply

public PktPacket reply

The sent/received reply packet.

This field contains the reply packet exchanged during the handshake. The reply was sent to the handshaking peer in case the handshake was kicked off in the State#ACCEPTED state. Otherwise, it was received from the handshaking peer.

status

public Exception status

The handshake completion status.

This field contains the handshake completion status. In case the handshake was successful, this field will be null and all the other fields in this class will be populated. Otherwise, this field will contain the cause of the handshake failure and the rest of the fields will be partially set depending on the state of the handshake when the failure occured.

flgReadOperationalOnStart

public boolean flgReadOperationalOnStart

Indicates whether the read was operational on the handshake link's tree when the handshake was initiated.

This field indicates whether the read was operational on the link's tree when the handshake was initiated. When the handshake is kicked off the handshaker stops the read (if started) on the link's tree and migrates the link tree to a new container that is driven by the handshaker thread. The handshake is conducted in the context of the handshaker thread. Upon successful completion of a handshake, the read is stopped, the link tree migrated back to the original container but the read is not restarted. The caller is responsible for restarting the read when appropriate. This field is intended for use by the caller to help in the decision. The read is always restarted in case the handshake failed.