org.snf4j.example.engine

Class CloseableEngine

java.lang.Object

org.snf4j.example.engine.AbstractEngine

org.snf4j.example.engine.BasicEngine

org.snf4j.example.engine.CloseableEngine

All Implemented Interfaces:

IEngine

Direct Known Subclasses:

HandshakingEngine

public class CloseableEngine
extends BasicEngine

Nested Class Summary

Nested classes/interfaces inherited from class org.snf4j.example.engine.AbstractEngine

AbstractEngine.CloseType

Field Summary

Fields inherited from class org.snf4j.example.engine.BasicEngine

offset

Fields inherited from class org.snf4j.example.engine.AbstractEngine

handshakeStatus, inboundDone, outboundDone

Constructor Summary

Constructors

Constructor and Description
CloseableEngine(int offset)

Method Summary

Modifier and Type	Method and Description
void	closeInbound() Signals that no more inbound network data will be sent to an IEngine implementation.
protected IEngineResult	closeWrap(ByteBuffer dst)
protected boolean	isClosingUnwrap(byte[] data)

Methods inherited from class org.snf4j.example.engine.BasicEngine

closeUnwrap, preUnwrap, preWrap, unwrap, wrap

Methods inherited from class org.snf4j.example.engine.AbstractEngine

beginHandshake, cleanup, closeOutbound, getDelegatedTask, getHandshakeStatus, getMaxApplicationBufferSize, getMaxNetworkBufferSize, getMinApplicationBufferSize, getMinNetworkBufferSize, getSession, init, isInboundDone, isOutboundDone, updateHandshakeStatus, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

CloseableEngine

public CloseableEngine(int offset)

Method Detail

closeInbound

public void closeInbound()
                  throws SessionIncidentException

Description copied from interface: IEngine

Signals that no more inbound network data will be sent to an IEngine implementation.

This method should be idempotent: if the inbound side has already been closed, this method should not do anything.

Specified by:

closeInbound in interface IEngine

Overrides:

closeInbound in class AbstractEngine

Throws:

SessionIncidentException - if this engine implementation detected an incident that should be reported to the associated session's handler (e.g. when an engine has not received a proper close message from the peer).

See Also:

IEngine.isInboundDone()

isClosingUnwrap

protected boolean isClosingUnwrap(byte[] data)

Overrides:

isClosingUnwrap in class BasicEngine

closeWrap

protected IEngineResult closeWrap(ByteBuffer dst)

Overrides:

closeWrap in class BasicEngine