Класс SSLEngineResult

java.lang.Object

javax.net.ssl.SSLEngineResult

public class SSLEngineResult extends Object

Оболочка для состояния результата, полученного в результате SSLEngine вызовов ввода-вывода.

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

С тех пор:

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 отрицательны
С тех пор:: 9

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

getStatus

public final SSLEngineResult.Status getStatus()

Получает возвращаемое значение этой SSLEngine операции.

Возвращает:: возвращаемое значение

getHandshakeStatus

public final SSLEngineResult.HandshakeStatus getHandshakeStatus()

Получает состояние рукопожатия данной SSLEngine операции.

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

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 если запись не сгенерирована или не потреблена, или эта операция не поддерживается базовым поставщиком

С тех пор:

См. также:

Long.compareUnsigned(long, long)

toString

public String toString()

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

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

© 1993, 2021, 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://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/net/ssl/SSLEngineResult.html