OpenJDK 27 · sun.nio.ch.sctp.MessageInfoImpl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final SocketAddress	address
private Association	association
private int	assocId
private final int	bytes
private boolean	complete
private int	ppid
private int	streamNumber
private long	timeToLive
private boolean	unordered

Access	Constructor and Description
public	MessageInfoImpl(Association association, SocketAddress address, int streamNumber)
private	MessageInfoImpl(int assocId, SocketAddress address, int bytes, int streamNumber, boolean complete, boolean unordered, int ppid)

Method Summary

Modifier and Type	Method and Description
public SocketAddress	address() Implements abstract com.sun.nio.sctp.MessageInfo.address. Returns the source socket address if the message has been received, otherwise the preferred destination of the message to be sent.
public Association	association() Implements abstract com.sun.nio.sctp.MessageInfo.association. Returns the association that the message was received on, if the message has been received, otherwise the association that the message is to be sent on.
pack-priv int	associationID()
public int	bytes() Implements abstract com.sun.nio.sctp.MessageInfo.bytes. Returns the number of bytes read for the received message.
public MessageInfo	complete(boolean complete) Implements abstract com.sun.nio.sctp.MessageInfo.complete. Sets whether or not the message is complete.
public boolean	isComplete() Implements abstract com.sun.nio.sctp.MessageInfo.isComplete. Tells whether or not the message is complete.
public boolean	isUnordered() Implements abstract com.sun.nio.sctp.MessageInfo.isUnordered. Tells whether or not the message is unordered.
public int	payloadProtocolID() Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID. Returns the payload protocol Identifier.
public MessageInfo	payloadProtocolID(int ppid) Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID. Sets the payload protocol Identifier.
pack-priv void	setAssociation(Association association) MessageInfoImpl instances created from native will need to have their association set from the channel.
public int	streamNumber() Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber. Returns the stream number that the message was received on, if the message has been received, otherwise the stream number that the message is to be sent on.
public MessageInfo	streamNumber(int streamNumber) Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber. Sets the stream number that the message is to be sent on.
public long	timeToLive() Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive. The time period that the sending side may expire the message if it has not been sent, or `0` to indicate that no timeout should occur.
public MessageInfo	timeToLive(long millis) Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive. Sets the time period that the sending side may expire the message if it has not been sent.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public MessageInfo	unordered(boolean unordered) Implements abstract com.sun.nio.sctp.MessageInfo.unordered. Sets whether or not the message is unordered.

Inherited from com.sun.nio.sctp.MessageInfo:: createOutgoing createOutgoing

address	back to summary
private final SocketAddress address

association	back to summary
private Association association

assocId	back to summary
private int assocId

bytes	back to summary
private final int bytes

complete	back to summary
private boolean complete

ppid	back to summary
private int ppid

streamNumber	back to summary
private int streamNumber

timeToLive	back to summary
private long timeToLive

unordered	back to summary
private boolean unordered

MessageInfoImpl	back to summary
public MessageInfoImpl(Association association, SocketAddress address, int streamNumber)

MessageInfoImpl	back to summary
private MessageInfoImpl(int assocId, SocketAddress address, int bytes, int streamNumber, boolean complete, boolean unordered, int ppid)

Method Detail

address	back to summary
public SocketAddress address() Implements abstract com.sun.nio.sctp.MessageInfo.address. Doc from com.sun.nio.sctp.MessageInfo.address. Returns the source socket address if the message has been received, otherwise the preferred destination of the message to be sent. Annotations @Override

address

back to summary

public SocketAddress address()

Implements abstract com.sun.nio.sctp.MessageInfo.address.

Doc from com.sun.nio.sctp.MessageInfo.address.

Returns the source socket address if the message has been received, otherwise the preferred destination of the message to be sent.

Annotations

@Override

association	back to summary
public Association association() Implements abstract com.sun.nio.sctp.MessageInfo.association. Doc from com.sun.nio.sctp.MessageInfo.association. Returns the association that the message was received on, if the message has been received, otherwise the association that the message is to be sent on. Annotations @Override

association

back to summary

public Association association()

Implements abstract com.sun.nio.sctp.MessageInfo.association.

Doc from com.sun.nio.sctp.MessageInfo.association.

Returns the association that the message was received on, if the message has been received, otherwise the association that the message is to be sent on.

Annotations

@Override

associationID	back to summary
pack-priv int associationID()

bytes	back to summary
public int bytes() Implements abstract com.sun.nio.sctp.MessageInfo.bytes. Doc from com.sun.nio.sctp.MessageInfo.bytes. Returns the number of bytes read for the received message. This method is only appicable for received messages, it has no meaning for messages being sent. Annotations @Override

bytes

back to summary

public int bytes()

Implements abstract com.sun.nio.sctp.MessageInfo.bytes.

Doc from com.sun.nio.sctp.MessageInfo.bytes.

Returns the number of bytes read for the received message.

This method is only appicable for received messages, it has no meaning for messages being sent.

Annotations

@Override

complete back to summary

complete	back to summary
public MessageInfo complete(boolean complete) Implements abstract com.sun.nio.sctp.MessageInfo.complete. Doc from com.sun.nio.sctp.MessageInfo.complete. Sets whether or not the message is complete. For messages being sent `true` indicates that the message is complete, `false` indicates that the message is not complete. How the send channel interprets this value depends on the value of its `SCTP_EXPLICIT_COMPLETE` socket option. Annotations @Override

public MessageInfo complete(boolean complete)

Implements abstract com.sun.nio.sctp.MessageInfo.complete.

Doc from com.sun.nio.sctp.MessageInfo.complete.

Sets whether or not the message is complete.

For messages being sent true indicates that the message is complete, false indicates that the message is not complete. How the send channel interprets this value depends on the value of its SCTP_EXPLICIT_COMPLETE socket option.

Annotations

@Override

isComplete back to summary

isComplete	back to summary
public boolean isComplete() Implements abstract com.sun.nio.sctp.MessageInfo.isComplete. Doc from com.sun.nio.sctp.MessageInfo.isComplete. Tells whether or not the message is complete. For received messages `true` indicates that the message was completely received. For messages being sent `true` indicates that the message is complete, `false` indicates that the message is not complete. How the send channel interprets this value depends on the value of its `SCTP_EXPLICIT_COMPLETE` socket option. Annotations @Override

public boolean isComplete()

Implements abstract com.sun.nio.sctp.MessageInfo.isComplete.

Doc from com.sun.nio.sctp.MessageInfo.isComplete.

Tells whether or not the message is complete.

For received messages true indicates that the message was completely received. For messages being sent true indicates that the message is complete, false indicates that the message is not complete. How the send channel interprets this value depends on the value of its SCTP_EXPLICIT_COMPLETE socket option.

Annotations

@Override

isUnordered back to summary

isUnordered	back to summary
public boolean isUnordered() Implements abstract com.sun.nio.sctp.MessageInfo.isUnordered. Doc from com.sun.nio.sctp.MessageInfo.isUnordered. Tells whether or not the message is unordered. For received messages `true` indicates that the message was sent non-ordered. For messages being sent `true` requests the un-ordered delivery of the message, `false` indicates that the message is ordered. Annotations @Override

public boolean isUnordered()

Implements abstract com.sun.nio.sctp.MessageInfo.isUnordered.

Doc from com.sun.nio.sctp.MessageInfo.isUnordered.

Tells whether or not the message is unordered. For received messages true indicates that the message was sent non-ordered. For messages being sent true requests the un-ordered delivery of the message, false indicates that the message is ordered.

Annotations

@Override

payloadProtocolID back to summary

payloadProtocolID	back to summary
public int payloadProtocolID() Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID. Doc from com.sun.nio.sctp.MessageInfo.payloadProtocolID. Returns the payload protocol Identifier. A value indicating the type of payload protocol data being transmitted/received. This value is passed as opaque data by SCTP. `0` indicates an unspecified payload protocol identifier. Annotations @Override

public int payloadProtocolID()

Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID.

Doc from com.sun.nio.sctp.MessageInfo.payloadProtocolID.

Returns the payload protocol Identifier.

A value indicating the type of payload protocol data being transmitted/received. This value is passed as opaque data by SCTP. 0 indicates an unspecified payload protocol identifier.

Annotations

@Override

payloadProtocolID	back to summary
public MessageInfo payloadProtocolID(int ppid) Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID. Doc from com.sun.nio.sctp.MessageInfo.payloadProtocolID. Sets the payload protocol Identifier. A value indicating the type of payload protocol data being transmitted. This value is passed as opaque data by SCTP. Annotations @Override

payloadProtocolID

back to summary

public MessageInfo payloadProtocolID(int ppid)

Implements abstract com.sun.nio.sctp.MessageInfo.payloadProtocolID.

Doc from com.sun.nio.sctp.MessageInfo.payloadProtocolID.

Sets the payload protocol Identifier.

A value indicating the type of payload protocol data being transmitted. This value is passed as opaque data by SCTP.

Annotations

@Override

setAssociation	back to summary
pack-priv void setAssociation(Association association) MessageInfoImpl instances created from native will need to have their association set from the channel.

streamNumber	back to summary
public int streamNumber() Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber. Doc from com.sun.nio.sctp.MessageInfo.streamNumber. Returns the stream number that the message was received on, if the message has been received, otherwise the stream number that the message is to be sent on. Annotations @Override

streamNumber

back to summary

public int streamNumber()

Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber.

Doc from com.sun.nio.sctp.MessageInfo.streamNumber.

Returns the stream number that the message was received on, if the message has been received, otherwise the stream number that the message is to be sent on.

Annotations

@Override

streamNumber	back to summary
public MessageInfo streamNumber(int streamNumber) Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber. Doc from com.sun.nio.sctp.MessageInfo.streamNumber. Sets the stream number that the message is to be sent on. Annotations @Override

streamNumber

back to summary

public MessageInfo streamNumber(int streamNumber)

Implements abstract com.sun.nio.sctp.MessageInfo.streamNumber.

Doc from com.sun.nio.sctp.MessageInfo.streamNumber.

Sets the stream number that the message is to be sent on.

Annotations

@Override

timeToLive back to summary

timeToLive	back to summary
public long timeToLive() Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive. Doc from com.sun.nio.sctp.MessageInfo.timeToLive. The time period that the sending side may expire the message if it has not been sent, or `0` to indicate that no timeout should occur. This value is only applicable for messages being sent, it has no meaning for received messages. Annotations @Override

public long timeToLive()

Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive.

Doc from com.sun.nio.sctp.MessageInfo.timeToLive.

The time period that the sending side may expire the message if it has not been sent, or 0 to indicate that no timeout should occur. This value is only applicable for messages being sent, it has no meaning for received messages.

Annotations

@Override

timeToLive	back to summary
public MessageInfo timeToLive(long millis) Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive. Doc from com.sun.nio.sctp.MessageInfo.timeToLive. Sets the time period that the sending side may expire the message if it has not been sent. Annotations @Override

timeToLive

back to summary

public MessageInfo timeToLive(long millis)

Implements abstract com.sun.nio.sctp.MessageInfo.timeToLive.

Doc from com.sun.nio.sctp.MessageInfo.timeToLive.

Sets the time period that the sending side may expire the message if it has not been sent.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

unordered	back to summary
public MessageInfo unordered(boolean unordered) Implements abstract com.sun.nio.sctp.MessageInfo.unordered. Doc from com.sun.nio.sctp.MessageInfo.unordered. Sets whether or not the message is unordered. Annotations @Override

unordered

back to summary

public MessageInfo unordered(boolean unordered)

Implements abstract com.sun.nio.sctp.MessageInfo.unordered.

Doc from com.sun.nio.sctp.MessageInfo.unordered.

Sets whether or not the message is unordered.

Annotations

@Override

public Class MessageInfoImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail