Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#pubctors) \| [Methods](https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#inhmethods)

# SSLEngineResult


`
public


class
SSLEngineResult
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | javax.net.ssl.SSLEngineResult |

<br />

*** ** * ** ***

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:**

- `https://developer.android.com/reference/javax/net/ssl/SSLEngine`
- `https://developer.android.com/reference/javax/net/ssl/SSLEngine#wrap(java.nio.ByteBuffer,%20java.nio.ByteBuffer)`
- `https://developer.android.com/reference/javax/net/ssl/SSLEngine#unwrap(java.nio.ByteBuffer,%20java.nio.ByteBuffer)`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#SSLEngineResult(javax.net.ssl.SSLEngineResult.Status,%20javax.net.ssl.SSLEngineResult.HandshakeStatus,%20int,%20int)(https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.Status status, https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced) ` Initializes a new instance of this class. |

| ### Public methods ||
|---|---|
| ` final int` | ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#bytesConsumed()() ` Returns the number of bytes consumed from the input buffer. |
| ` final int` | ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#bytesProduced()() ` Returns the number of bytes written to the output buffer. |
| ` final https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.HandshakeStatus` | ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#getHandshakeStatus()() ` Gets the handshake status of this `SSLEngine` operation. |
| ` final https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.Status` | ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#getStatus()() ` Gets the return value of this `SSLEngine` operation. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/javax/net/ssl/SSLEngineResult#toString()() ` Returns a String representation of this object. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Public constructors

### SSLEngineResult

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Initializes a new instance of this class.

<br />

| Parameters ||
|---|---|
| `status` | `SSLEngineResult.Status`: the return value of the operation. <br /> |
| `handshakeStatus` | `SSLEngineResult.HandshakeStatus`: the current handshaking status. <br /> |
| `bytesConsumed` | `int`: the number of bytes consumed from the source ByteBuffer <br /> |
| `bytesProduced` | `int`: the number of bytes placed into the destination ByteBuffer <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the `status` or `handshakeStatus` arguments are null, or if `bytesConsumed` or `bytesProduced` is negative. |

## Public methods

### bytesConsumed

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final int bytesConsumed ()
```

Returns the number of bytes consumed from the input buffer.

<br />

| Returns ||
|---|---|
| `int` | the number of bytes consumed. <br /> |

### bytesProduced

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final int bytesProduced ()
```

Returns the number of bytes written to the output buffer.

<br />

| Returns ||
|---|---|
| `int` | the number of bytes produced <br /> |

### getHandshakeStatus

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final SSLEngineResult.HandshakeStatus getHandshakeStatus ()
```

Gets the handshake status of this `SSLEngine`
operation.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.HandshakeStatus` | the handshake status <br /> |

### getStatus

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final SSLEngineResult.Status getStatus ()
```

Gets the return value of this `SSLEngine` operation.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/javax/net/ssl/SSLEngineResult.Status` | the return value <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a String representation of this object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |