Класс SSLEngineResult

java.lang.Object

javax.net.ssl.SSLEngineResult

public class SSLEngineResult extends Object

Инкапсулирует состояние результата, полученного в ходе операций ввода-вывода.

Объект SSLEngine используется для установления защищённых сеансов связи между двумя участниками. Операции обычно потребляют байты из входного буфера и производят байты в выходной буфер. Этот класс предоставляет значения результата операций, описывающие состояние процесса, включая указания о необходимых операциях для завершения текущего процесса рукопожатия. Также, он сообщает количество потреблённых и произведённых байтов в результате этой операции.

Since:

1.5

См. также:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static enum`	`SSLEngineResult.HandshakeStatus`	Перечисление, описывающее текущее состояние процесса рукопожатия данного объекта `SSLEngine`.
`static enum`	`SSLEngineResult.Status`	Перечисление, описывающее общий результат операции `SSLEngine`.

Краткое описание конструкторов

Конструктор	Описание
`SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced)`	Инициализирует новый экземпляр этого класса.
`SSLEngineResult(SSLEngineResult.Status status, SSLEngineResult.HandshakeStatus handshakeStatus, int bytesConsumed, int bytesProduced, long sequenceNumber)`	Инициализирует новый экземпляр этого класса.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final int`	`bytesConsumed()`	Возвращает количество байтов, потреблённых из входного буфера.
`final int`	`bytesProduced()`	Возвращает количество байтов, записанных в выходной буфер.
`final SSLEngineResult.HandshakeStatus`	`getHandshakeStatus()`	Возвращает статус процесса рукопожатия этой операции `SSLEngine`.
`final SSLEngineResult.Status`	`getStatus()`	Возвращает результат выполнения этой операции `SSLEngine`.
`final long`	`sequenceNumber()`	Возвращает порядковый номер произведённого или потреблённого SSL/TLS/DTLS-записи (дополнительная операция).
`String`	`toString()`	Возвращает строковое представление этого объекта.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

SSLEngineResult

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

Инициализирует новый экземпляр этого класса.

Параметры:: status - результат операции.; handshakeStatus - текущий статус процесса рукопожатия.; bytesConsumed - количество потреблённых байтов из источника ByteBuffer; bytesProduced - количество байтов, помещённых в целевой ByteBuffer
Исключения:: IllegalArgumentException - если аргументы status или handshakeStatus равны null, или если bytesConsumed или bytesProduced отрицательны.

SSLEngineResult

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

Инициализирует новый экземпляр этого класса.

Параметры:: status - результат операции.; handshakeStatus - текущий статус процесса рукопожатия.; bytesConsumed - количество потреблённых байтов из источника ByteBuffer; bytesProduced - количество байтов, помещённых в целевой ByteBuffer; sequenceNumber - порядковый номер (безусловное целое число) произведённой или потреблённой SSL/TLS/DTLS записи, или -1L, если запись не произведена или не потребляется
Исключения:: IllegalArgumentException - если аргументы status или handshakeStatus равны null, или если bytesConsumed или bytesProduced отрицательны
Since:: 9

Подробное описание методов

getStatus

public final SSLEngineResult.Status getStatus()

Возвращает результат выполнения этой операции.

Возвращает:: результат

getHandshakeStatus

public final SSLEngineResult.HandshakeStatus getHandshakeStatus()

Возвращает статус процесса рукопожатия этой операции.

Возвращает:: статус рукопожатия

bytesConsumed

public final int bytesConsumed()

Возвращает количество байтов, потреблённых из входного буфера.

Возвращает:: количество потреблённых байтов.

bytesProduced

public final int bytesProduced()

Возвращает количество байтов, записанных в выходной буфер.

Возвращает:: количество произведённых байтов

sequenceNumber

public final long sequenceNumber()

Возвращает порядковый номер произведённой или потреблённой SSL/TLS/DTLS-записи (дополнительная операция).

Примечание API:

Обратите внимание, что порядковый номер - это целое без знака, которое не может превышать -1L. Желательно использовать сравнение целых без знака для сравнения целых без знака (см. также Long.compareUnsigned()).

Для протоколов DTLS, первые 16 бит порядкового номера - это значение счётчика (эпохи), которое инкрементируется при каждом изменении состояния шифра. Оставшиеся 48 битов представляют собой последовательность записи, которая поддерживается отдельно для каждой эпохи.

Примечание реализации:

Рекомендуется, чтобы поставщики никогда не допускали увеличения порядкового номера до -1L. Если порядковый номер близок к переполнению, следует запросить переподключение, в противном случае соединение следует закрыть немедленно. Это должно выполняться автоматически базовой реализацией.

Возвращает:

порядковый номер произведённой или потреблённой SSL/TLS/DTLS-записи; или -1L, если запись не произведена или не потребляется, или эта операция не поддерживается базовым поставщиком

Since:

См. также:

toString

public String toString()

Возвращает строковое представление этого объекта.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/javax/net/ssl/SSLEngineResult.html