org.snf4j.example.engine

Class BasicEngine

java.lang.Object

org.snf4j.example.engine.AbstractEngine

org.snf4j.example.engine.BasicEngine

All Implemented Interfaces:

IEngine

Direct Known Subclasses:

CloseableEngine

public class BasicEngine
extends AbstractEngine

Nested Class Summary

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

AbstractEngine.CloseType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	offset

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

handshakeStatus, inboundDone, outboundDone

Constructor Summary

Constructors

Constructor and Description
BasicEngine(int offset)

Method Summary

Modifier and Type	Method and Description
protected IEngineResult	closeUnwrap(ByteBuffer dst)
protected IEngineResult	closeWrap(ByteBuffer dst)
protected boolean	isClosingUnwrap(byte[] data)
protected IEngineResult	preUnwrap(ByteBuffer src, ByteBuffer dst)
protected IEngineResult	preWrap(ByteBuffer[] srcs, ByteBuffer dst)
IEngineResult	unwrap(ByteBuffer src, ByteBuffer dst) Attempts to encode inbound network data from a data buffer into inbound application data.
IEngineResult	wrap(ByteBuffer[] srcs, ByteBuffer dst) Attempts to encode outbound application data from a subsequence of data buffers into outbound network data.

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

beginHandshake, cleanup, closeInbound, 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

Field Detail

offset

protected int offset

Constructor Detail

BasicEngine

public BasicEngine(int offset)

Method Detail

closeWrap

protected IEngineResult closeWrap(ByteBuffer dst)

preWrap

protected IEngineResult preWrap(ByteBuffer[] srcs,
                                ByteBuffer dst)

wrap

public IEngineResult wrap(ByteBuffer[] srcs,
                          ByteBuffer dst)
                   throws Exception

Description copied from interface: IEngine

Attempts to encode outbound application data from a subsequence of data buffers into outbound network data.

Depending on the state of an IEngine implementation, this method can produce network data without consuming any application data (for example, it may generate handshake data.)

If an IEngine implementation has not yet started its initial handshake, this method should automatically start the handshake.

Parameters:

srcs - an array of ByteBuffers containing the outbound application data

dst - a ByteBuffer to hold outbound network data

Returns:

an EngineResult describing the result of this operation.

Throws:

Exception - when a problem occurred. Once it is thrown the associated session will be quickly closed

closeUnwrap

protected IEngineResult closeUnwrap(ByteBuffer dst)

isClosingUnwrap

protected boolean isClosingUnwrap(byte[] data)

preUnwrap

protected IEngineResult preUnwrap(ByteBuffer src,
                                  ByteBuffer dst)

unwrap

public IEngineResult unwrap(ByteBuffer src,
                            ByteBuffer dst)
                     throws Exception

Description copied from interface: IEngine

Attempts to encode inbound network data from a data buffer into inbound application data.

Depending on the state of an IEngine implementation, this method can consume network data without producing any application data (for example, it may generate handshake data.)

If an IEngine implementation has not yet started its initial handshake, this method should automatically start the handshake.

Parameters:

src - a ByteBuffer containing the inbound application data

dst - a ByteBuffer to hold inbound application data

Returns:

an EngineResult describing the result of this operation.

Throws:

Exception - when a problem occurred. Once it is thrown the associated session will be quickly closed