Класс MessageInfo

java.lang.Object

com.sun.nio.sctp.MessageInfo

public abstract class MessageInfo extends Object

Класс MessageInfo предоставляет дополнительную вспомогательную информацию о сообщениях.

Полученные сообщения SCTP, возвращаемые методами SctpChannel.receive и SctpMultiChannel.receive, возвращают экземпляр MessageInfo, который можно использовать для получения вспомогательной информации о полученном сообщении. Отправляемые сообщения должны использовать один из методов createOutgoing для предоставления вспомогательных данных для отправляемого сообщения и могут использовать соответствующие методы-сеттеры для переопределения значений по умолчанию для unordered, timeToLive, complete и payloadProtocolID перед отправкой сообщения.

Для исходящих сообщений параметр timeToLive представляет собой временной интервал, в течение которого отправляющая сторона SCTP-стек может аннулировать сообщение, если оно не было отправлено. Этот интервал указывает стеку, что сообщение больше не требуется для отправки после истечения интервала. Это не жёсткий таймаут и может зависеть от того, поддерживает ли ассоциация расширение частичной надёжности, RFC 3758.

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

Since:: 1.7

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

MessageInfo()

Модификатор	Конструктор	Описание
`protected`	Инициализирует новый экземпляр этого класса.

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

Модификатор и тип	Метод	Описание
`abstract SocketAddress`	`address()`	Возвращает адрес сокета источника, если сообщение было получено, в противном случае - предпочтительный адрес назначения отправляемого сообщения.
`abstract Association`	`association()`	Возвращает ассоциацию, на которой было получено сообщение, если сообщение было получено, в противном случае - ассоциацию, на которой сообщение должно быть отправлено.
`abstract int`	`bytes()`	Возвращает количество считанных байтов для полученного сообщения.
`abstract MessageInfo`	`complete(boolean complete)`	Устанавливает, является ли сообщение полным.
`static MessageInfo`	`createOutgoing(Association association, SocketAddress address, int streamNumber)`	Создаёт экземпляр `MessageInfo`, подходящий для отправки сообщения заданной ассоциации.
`static MessageInfo`	`createOutgoing(SocketAddress address, int streamNumber)`	Создаёт экземпляр `MessageInfo`, подходящий для отправки сообщения.
`abstract boolean`	`isComplete()`	Указывает, является ли сообщение полным.
`abstract boolean`	`isUnordered()`	Указывает, является ли сообщение неупорядоченным.
`abstract int`	`payloadProtocolID()`	Возвращает идентификатор протокола полезной нагрузки.
`abstract MessageInfo`	`payloadProtocolID(int ppid)`	Устанавливает идентификатор протокола полезной нагрузки.
`abstract int`	`streamNumber()`	Возвращает номер потока, на котором было получено сообщение, если сообщение было получено, в противном случае - номер потока, на котором сообщение должно быть отправлено.
`abstract MessageInfo`	`streamNumber(int streamNumber)`	Устанавливает номер потока, на котором сообщение должно быть отправлено.
`abstract long`	`timeToLive()`	Временной интервал, в течение которого отправляющая сторона может аннулировать сообщение, если оно не было отправлено, или `0`, чтобы указать, что таймаут не должен происходить.
`abstract MessageInfo`	`timeToLive(long millis)`	Устанавливает временной интервал, в течение которого отправляющая сторона может аннулировать сообщение, если оно не было отправлено.
`abstract MessageInfo`	`unordered(boolean unordered)`	Устанавливает, является ли сообщение неупорядоченным.

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

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

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

MessageInfo

protected MessageInfo()

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

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

createOutgoing

public static MessageInfo createOutgoing(SocketAddress address, int streamNumber)

Создаёт экземпляр MessageInfo подходящий для отправки сообщения.

Возвращённый экземпляр будет иметь значение unordered установленное в false, значение timeToLive установленное в 0, значение complete установленное в true, и значение payloadProtocolID установленное в 0. Эти значения, при необходимости, могут быть изменены через соответствующие методы перед отправкой сообщения.

Параметры:: address - Для подключённого SctpChannel адрес является предпочтительным адресом узла, для отправки сообщения, или null для использования первичного адреса узла. Для SctpMultiChannel адрес используется для определения ассоциации, или если ассоциации с узлом, по этому адресу, не существует, то она создаётся.; streamNumber - Номер потока, по которому будет отправлено сообщение
Возвращаемое значение:: Информация об исходящем сообщении
Исключения:: IllegalArgumentException - Если streamNumber отрицательный или больше, чем 65536

createOutgoing

public static MessageInfo createOutgoing(Association association, SocketAddress address, int streamNumber)

Создаёт экземпляр MessageInfo подходящий для отправки сообщения заданной ассоциации. Обычно используется для SctpMultiChannel когда ассоциация уже установлена.

Параметры:: association - Ассоциация для отправки сообщения; address - Предпочтительный адрес узла ассоциации для отправки сообщения, или null для использования первичного адреса узла; streamNumber - Номер потока, по которому будет отправлено сообщение.
Возвращаемое значение:: Информация об исходящем сообщении
Исключения:: IllegalArgumentException - Если association равно null, или streamNumber отрицательный или больше, чем 65536

address

public abstract SocketAddress address()

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

Возвращаемое значение:: Адрес сокета, или null если этот экземпляр используется для отправки сообщения и был создан без указания предпочтительного адреса назначения

association

public abstract Association association()

Возвращает ассоциацию, по которой было получено сообщение, если сообщение было получено, в противном случае ассоциацию, по которой сообщение должно быть отправлено.

Возвращаемое значение:: Ассоциация, или null если этот экземпляр используется для отправки сообщения и был создан с использованием статического фабричного метода createOutgoing(SocketAddress,int)

bytes

public abstract int bytes()

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

Этот метод применим только для полученных сообщений, он не имеет смысла для отправляемых сообщений.

Возвращаемое значение:: Количество прочитанных байтов, -1 если канал является SctpChannel достигший конца потока, в противном случае 0

isComplete

public abstract boolean isComplete()

Указывает, является ли сообщение полным.

Для полученных сообщений true указывает, что сообщение было полностью получено. Для отправляемых сообщений true указывает, что сообщение полное, false указывает, что сообщение не полное. Как канал отправки интерпретирует это значение, зависит от значения сокета SCTP_EXPLICIT_COMPLETE.

Возвращаемое значение:: true если, и только если, сообщение полное

complete

public abstract MessageInfo complete(boolean complete)

Устанавливает, является ли сообщение полным.

Для отправляемых сообщений true указывает, что сообщение полное, false указывает, что сообщение не полное. Как канал отправки интерпретирует это значение, зависит от значения сокета SCTP_EXPLICIT_COMPLETE.

Параметры:

complete - true если, и только если, сообщение полное

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

Это MessageInfo

См. также:

isComplete()

isUnordered

public abstract boolean isUnordered()

Указывает, является ли сообщение неупорядоченным. Для полученных сообщений true указывает, что сообщение было отправлено неупорядоченным. Для отправляемых сообщений true запрашивает неупорядоченную доставку сообщения, false указывает, что сообщение упорядоченное.

Возвращаемое значение:: true если сообщение неупорядоченное, в противном случае false

unordered

public abstract MessageInfo unordered(boolean unordered)

Устанавливает, является ли сообщение неупорядоченным.

Параметры:

unordered - true запрашивает неупорядоченную доставку сообщения, false указывает, что сообщение упорядоченное.

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

Это MessageInfo

См. также:

isUnordered()

payloadProtocolID

public abstract int payloadProtocolID()

Возвращает идентификатор протокола полезной нагрузки.

Значение, указывающее тип данных протокола полезной нагрузки, передаваемого/получаемого. Это значение передаётся как необработанные данные протоколом SCTP. 0 указывает не указанный идентификатор протокола полезной нагрузки.

Возвращаемое значение:: Идентификатор протокола полезной нагрузки

payloadProtocolID

public abstract MessageInfo payloadProtocolID(int ppid)

Устанавливает идентификатор протокола полезной нагрузки.

Значение, указывающее тип данных протокола полезной нагрузки, передаваемого. Это значение передаётся как необработанные данные протоколом SCTP.

Параметры:

ppid - Идентификатор протокола полезной нагрузки, или 0 указывает не указанный идентификатор протокола полезной нагрузки.

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

Это MessageInfo

См. также:

payloadProtocolID()

streamNumber

public abstract int streamNumber()

Возвращает номер потока, по которому было получено сообщение, если сообщение было получено, в противном случае номер потока, по которому сообщение должно быть отправлено.

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

streamNumber

public abstract MessageInfo streamNumber(int streamNumber)

Устанавливает номер потока, по которому сообщение должно быть отправлено.

Параметры:: streamNumber - Номер потока
Возвращаемое значение:: Это MessageInfo
Исключения:: IllegalArgumentException - Если streamNumber отрицательный или больше, чем 65536

timeToLive

public abstract long timeToLive()

Период времени, в течение которого сторона отправки может истечь сообщение, если оно не было отправлено, или 0 чтобы указать, что таймаут не должен происходить. Это значение применимо только для отправляемых сообщений, оно не имеет значения для полученных сообщений.

Возвращаемое значение:: Период времени в миллисекундах, или 0

timeToLive

public abstract MessageInfo timeToLive(long millis)

Устанавливает период времени, в течение которого сторона отправки может истечь сообщение, если оно не было отправлено.

Параметры:

millis - Период времени в миллисекундах, или 0 чтобы указать, что таймаут не должен происходить

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

Это MessageInfo

См. также:

timeToLive()

© 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/jdk.sctp/com/sun/nio/sctp/MessageInfo.html