org.snf4j.core.engine

Interface IEngineResult

All Known Implementing Classes:

EngineResult

public interface IEngineResult

An interface encapsulating the result state produced by the IEngine calls.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
int	bytesConsumed() Returns the number of bytes consumed from the input buffer.
int	bytesProduced() Returns the number of bytes written to the output buffer.
HandshakeStatus	getHandshakeStatus() Gets the current handshake status produced by the IEngine call.
Status	getStatus() Gets the overall result of the IEngine calls.

Method Detail

bytesConsumed

int bytesConsumed()

Returns the number of bytes consumed from the input buffer.

Returns:

the number of bytes consumed.

bytesProduced

int bytesProduced()

Returns the number of bytes written to the output buffer.

Returns:

the number of bytes produced

getStatus

Status getStatus()

Gets the overall result of the IEngine calls.

Returns:

the return value

getHandshakeStatus

HandshakeStatus getHandshakeStatus()

Gets the current handshake status produced by the IEngine call. It should match the value returned by the IEngine.getHandshakeStatus() method. The only exception to this rule is when the call has just finished the ongoing handshake. In such situation this method should return the HandshakeStatus.FINISHED status which is forbidden for the IEngine.getHandshakeStatus() method.

Returns:

the handshake status