SSLEngineResult

An encapsulation of the result state produced by <code>SSLEngine</code> I/O calls.

<p> A <code>SSLEngine</code> provides a means for establishing secure communication sessions between two peers. <code>SSLEngine</code> operations typically consume bytes from an input buffer and produce bytes in an output buffer. This class provides operational result values describing the state of the <code>SSLEngine</code>, including indications of what operations are needed to finish an ongoing handshake. Lastly, it reports the number of bytes consumed and produced as a result of this operation.

@see SSLEngine @see SSLEngine#wrap(ByteBuffer, ByteBuffer) @see SSLEngine#unwrap(ByteBuffer, ByteBuffer)

@author Brad R. Wetmore

class SSLEngineResult {

enum Status;

this(Status status, HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced);

Status getStatus();

HandshakeStatus getHandshakeStatus();

int bytesConsumed();

int bytesProduced();

string toString();

}

Constructors

this this(Status status, HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced): Initializes a new instance of this class.

Members

Enums

Status enum Status: An <code>SSLEngineResult</code> enum describing the overall result of the <code>SSLEngine</code> operation.

Functions

bytesConsumed int bytesConsumed(): Returns the number of bytes consumed from the input buffer.
bytesProduced int bytesProduced(): Returns the number of bytes written to the output buffer.
getHandshakeStatus HandshakeStatus getHandshakeStatus(): Gets the handshake status of this <code>SSLEngine</code> operation.
getStatus Status getStatus(): Gets the return value of this <code>SSLEngine</code> operation.
toString string toString(): Returns a string representation of this object.

SSLEngineResult

Constructors

Members

Enums

Functions

Meta

Source