public class

SSLEngineResult

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

Class Overview

The result object describing the state of the SSLEngine produced by the wrap() and unwrap() operations.

Summary

Nested Classes
enum SSLEngineResult.HandshakeStatus The enum describing the state of the current handshake. 
enum SSLEngineResult.Status The enum describing the result of the SSLEngine operation. 
Public Constructors
SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)
Creates a new SSLEngineResult instance with the specified state values.
Public Methods
final int bytesConsumed()
Returns the number of bytes retrieved from the source buffer(s).
final int bytesProduced()
Returns the number of bytes transferred to the destination buffer(s).
final SSLEngineResult.HandshakeStatus getHandshakeStatus()
Returns the status of the current handshake.
final SSLEngineResult.Status getStatus()
Returns the return value of the SSLEngine operation.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

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

Since: API Level 1

Creates a new SSLEngineResult instance with the specified state values.

Parameters
status the return value of the SSLEngine operation.
handshakeStatus the status of the current handshake
bytesConsumed the number of bytes retrieved from the source buffer(s).
bytesProduced the number of bytes transferred to the destination buffer(s).
Throws
IllegalArgumentException if status or handshakeStatus is null, or if bytesConsumed or bytesProduces are negative.

Public Methods

public final int bytesConsumed ()

Since: API Level 1

Returns the number of bytes retrieved from the source buffer(s).

Returns
  • the number of bytes retrieved from the source buffer(s).

public final int bytesProduced ()

Since: API Level 1

Returns the number of bytes transferred to the destination buffer(s).

Returns
  • the number of bytes transferred to the destination buffer(s).

public final SSLEngineResult.HandshakeStatus getHandshakeStatus ()

Since: API Level 1

Returns the status of the current handshake.

Returns
  • the status of the current handshake.

public final SSLEngineResult.Status getStatus ()

Since: API Level 1

Returns the return value of the SSLEngine operation.

Returns
  • the return value of the SSLEngine operation.

public String toString ()

Since: API Level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.