Skip to content

Most visited

Recently visited

navigation
Added in API level 1

SSLEngineResult

public class SSLEngineResult
extends Object

java.lang.Object
   ↳ javax.net.ssl.SSLEngineResult


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

A SSLEngine provides a means for establishing secure communication sessions between two peers. SSLEngine 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 SSLEngine, 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 also:

Summary

Nested classes

enum SSLEngineResult.HandshakeStatus

An SSLEngineResult enum describing the current handshaking state of this SSLEngine

enum SSLEngineResult.Status

An SSLEngineResult enum describing the overall result of the SSLEngine operation. 

Public constructors

SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)

Initializes a new instance of this class.

Public methods

final int bytesConsumed()

Returns the number of bytes consumed from the input buffer.

final int bytesProduced()

Returns the number of bytes written to the output buffer.

final SSLEngineResult.HandshakeStatus getHandshakeStatus()

Gets the handshake status of this SSLEngine operation.

final SSLEngineResult.Status getStatus()

Gets the return value of this SSLEngine operation.

String toString()

Returns a String representation of this object.

Inherited methods

From class java.lang.Object

Public constructors

SSLEngineResult

Added in API level 1
SSLEngineResult (SSLEngineResult.Status status, 
                SSLEngineResult.HandshakeStatus handshakeStatus, 
                int bytesConsumed, 
                int bytesProduced)

Initializes a new instance of this class.

Parameters
status SSLEngineResult.Status: the return value of the operation.
handshakeStatus SSLEngineResult.HandshakeStatus: the current handshaking status.
bytesConsumed int: the number of bytes consumed from the source ByteBuffer
bytesProduced int: the number of bytes placed into the destination ByteBuffer
Throws
IllegalArgumentException if the status or handshakeStatus arguments are null, or if <bytesConsumed or bytesProduced is negative.

Public methods

bytesConsumed

Added in API level 1
int bytesConsumed ()

Returns the number of bytes consumed from the input buffer.

Returns
int the number of bytes consumed.

bytesProduced

Added in API level 1
int bytesProduced ()

Returns the number of bytes written to the output buffer.

Returns
int the number of bytes produced

getHandshakeStatus

Added in API level 1
SSLEngineResult.HandshakeStatus getHandshakeStatus ()

Gets the handshake status of this SSLEngine operation.

Returns
SSLEngineResult.HandshakeStatus the handshake status

getStatus

Added in API level 1
SSLEngineResult.Status getStatus ()

Gets the return value of this SSLEngine operation.

Returns
SSLEngineResult.Status the return value

toString

Added in API level 1
String toString ()

Returns a String representation of this object.

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.