SSLEngineResult
open class SSLEngineResult
| kotlin.Any | |
| ↳ | 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.
Summary
| Nested classes | |
|---|---|
|
An |
|
|
An |
|
| Public constructors | |
|---|---|
SSLEngineResult(status: SSLEngineResult.Status!, handshakeStatus: SSLEngineResult.HandshakeStatus!, bytesConsumed: Int, bytesProduced: Int)Initializes a new instance of this class. |
|
| Public methods | |
|---|---|
| Int |
Returns the number of bytes consumed from the input buffer. |
| Int |
Returns the number of bytes written to the output buffer. |
| SSLEngineResult.HandshakeStatus! |
Gets the handshake status of this |
| SSLEngineResult.Status! |
Gets the return value of this |
| open String |
toString()Returns a String representation of this object. |
Public constructors
SSLEngineResult
SSLEngineResult(
status: SSLEngineResult.Status!,
handshakeStatus: SSLEngineResult.HandshakeStatus!,
bytesConsumed: Int,
bytesProduced: Int)
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 |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the status or handshakeStatus arguments are null, or if bytesConsumed or bytesProduced is negative. |
Public methods
bytesConsumed
fun bytesConsumed(): Int
Returns the number of bytes consumed from the input buffer.
| Return | |
|---|---|
Int |
the number of bytes consumed. |
bytesProduced
fun bytesProduced(): Int
Returns the number of bytes written to the output buffer.
| Return | |
|---|---|
Int |
the number of bytes produced |
getHandshakeStatus
fun getHandshakeStatus(): SSLEngineResult.HandshakeStatus!
Gets the handshake status of this SSLEngine operation.
| Return | |
|---|---|
SSLEngineResult.HandshakeStatus! |
the handshake status |
getStatus
fun getStatus(): SSLEngineResult.Status!
Gets the return value of this SSLEngine operation.
| Return | |
|---|---|
SSLEngineResult.Status! |
the return value |
toString
open fun toString(): String
Returns a String representation of this object.
| Return | |
|---|---|
String |
a string representation of the object. |