com.neeve.link
Class ILnkPeerEndpoint.SynchronousNonBlockingFlushContext

java.lang.Object
  com.neeve.link.ILnkPeerEndpoint.FlushContext
      com.neeve.link.ILnkPeerEndpoint.SynchronousNonBlockingFlushContext

Enclosing interface:

ILnkPeerEndpoint

public static final class ILnkPeerEndpoint.SynchronousNonBlockingFlushContext
extends ILnkPeerEndpoint.FlushContext

Context for synchronous non-blocking flushing through a peer endpoint..

The user provides an instance of this class to the ILnkPeerEndpoint.enque(short, com.neeve.pkt.PktPacket, com.neeve.link.ILnkPeerEndpoint.FlushContext, int) and ILnkPeerEndpoint.flush(short, com.neeve.link.ILnkPeerEndpoint.FlushContext) methods to request for synchronous non-blocking flush semantics.

Nested Class Summary

Nested classes/interfaces inherited from class com.neeve.link.ILnkPeerEndpoint.FlushContext

ILnkPeerEndpoint.FlushContext.FlushMode

Field Summary

boolean

complete Indicates whether the endpoint was flushed completely or not.

Fields inherited from class com.neeve.link.ILnkPeerEndpoint.FlushContext

flushMode

Constructor Summary

ILnkPeerEndpoint.SynchronousNonBlockingFlushContext()
Constructor

Method Summary

void	reset() Implemented FlushContext method
String	toString() String representation

Methods inherited from class com.neeve.link.ILnkPeerEndpoint.FlushContext

getAttachment, setAttachment

Methods inherited from class java.lang.Object

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

Field Detail

complete

public boolean complete

Indicates whether the endpoint was flushed completely or not.

Upon successful return from the ILnkPeerEndpoint.enque(short, com.neeve.pkt.PktPacket, com.neeve.link.ILnkPeerEndpoint.FlushContext, int) method, this field is set to true in case the enque method implictly and completely flushed the endpoint. A value of false indicates that the endpoint was either not flushed at all or incompletely flushed. The return value from the enque method used alongwith the value returned in this field can be used to distinguish between whether the endpoint was flushed incompletely or not flush at all.

Upon successful return from the ILnkPeerEndpoint.flush(short, com.neeve.link.ILnkPeerEndpoint.FlushContext) method, this field will be true in case the endpoint was flushed completely. A value of false indicates that the endpoint could not be flushed completely and the user should retry the flush at a later point.

Constructor Detail

ILnkPeerEndpoint.SynchronousNonBlockingFlushContext

public ILnkPeerEndpoint.SynchronousNonBlockingFlushContext()

Constructor

Method Detail

reset

public final void reset()

Implemented FlushContext method

Specified by:

reset in class ILnkPeerEndpoint.FlushContext

toString

public final String toString()

String representation

Overrides:

toString in class ILnkPeerEndpoint.FlushContext