OpenJDK 27 · com.sun.nio.sctp.SctpMultiChannel · APIdia, the JavaDoc alternative

Socket options
Option Name	Description
`SCTP_DISABLE_FRAGMENTS`	Enables or disables message fragmentation
`SCTP_EXPLICIT_COMPLETE`	Enables or disables explicit message completion
`SCTP_FRAGMENT_INTERLEAVE`	Controls how the presentation of messages occur for the message receiver
`SCTP_INIT_MAXSTREAMS`	The maximum number of streams requested by the local endpoint during association initialization
`SCTP_NODELAY`	Enables or disable a Nagle-like algorithm
`SCTP_PRIMARY_ADDR`	Requests that the local SCTP stack use the given peer address as the association primary
`SCTP_SET_PEER_PRIMARY_ADDR`	Requests that the peer mark the enclosed address as the association primary
`SO_SNDBUF`	The size of the socket send buffer
`SO_RCVBUF`	The size of the socket receive buffer
`SO_LINGER`	Linger on close if data is present (when configured in blocking mode only)

Access	Constructor and Description
protected	SctpMultiChannel(SelectorProvider The selector provider for this channel provider) Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
public abstract Set<Association>	Returns: A `Set` containing the open associations, or an empty `Set` if there are none. associations() Returns the open associations on this channel's socket.
public abstract SctpMultiChannel	Returns: This channel bind(SocketAddress The local address to bind the socket, or `null` to bind the socket to an automatically assigned socket address local, int The maximum number of pending connections backlog) Binds the channel's socket to a local address and configures the socket to listen for connections.
public final SctpMultiChannel	Returns: This channel bind(SocketAddress The local address to bind the socket, or `null` to bind the socket to an automatically assigned socket address local) Binds the channel's socket to a local address and configures the socket to listen for connections.
public abstract SctpMultiChannel	Returns: This channel bindAddress(InetAddress The address to add to the bound addresses for the socket address) Adds the given address to the bound addresses for the channel's socket.
public abstract SctpChannel	Returns: The `SctpChannel` branch(Association The association to branch off association) Branches off an association.
public abstract Set<SocketAddress>	Returns: All the socket addresses that this channel's socket is bound to, or an empty `Set` if the channel's socket is not bound getAllLocalAddresses() Returns all of the socket addresses to which this channel's socket is bound.
public abstract < The type of the socket option value T> T	Returns: The value of the socket option. A value of `null` may be a valid value for some socket options. getOption(SctpSocketOption<T> The socket option name, Association The association whose option should be retrieved, or `null` if this option should be retrieved at the channel's socket level. association) Returns the value of a socket option.
public abstract Set<SocketAddress>	Returns: All of the remote addresses for the given association, or an empty `Set` if the association has been shutdown getRemoteAddresses(Association The association association) Returns all of the remote addresses to which the given association on this channel's socket is connected.
public static SctpMultiChannel	Returns: A new SCTP multi channel open() Opens an SCTP multi channel.
public abstract < The type of the attachment T> MessageInfo	Returns: The `MessageInfo`, `null` if this channel is in non-blocking mode and no messages are immediately available or the notification handler returns `RETURN` after handling a notification receive(ByteBuffer The buffer into which bytes are to be transferred buffer, T The object to attach to the receive operation; can be `null` attachment, NotificationHandler<T> A handler to handle notifications from the SCTP stack, or `null` to ignore any notifications. handler) Receives a message and/or handles a notification via this channel.
public abstract int	Returns: The number of bytes sent, which will be either the number of bytes that were remaining in the messages buffer when this method was invoked or, if this channel is non-blocking, may be zero if there was insufficient room for the message in the underlying output buffer send(ByteBuffer The buffer containing the message to be sent buffer, MessageInfo Ancillary data about the message to be sent messageInfo) Sends a message via this channel.
public abstract < The type of the socket option value T> SctpMultiChannel	Returns: This channel setOption(SctpSocketOption<T> The socket option name, T The value of the socket option. A value of `null` may be a valid value for some socket options. value, Association The association whose option should be set, or `null` if this option should be set at the channel's socket level. association) Sets the value of a socket option.
public abstract SctpMultiChannel	Returns: This channel shutdown(Association The association to shutdown association) Shutdown an association without closing the channel.
public abstract Set<SctpSocketOption<?>>	Returns: A set of the socket options supported by this channel supportedOptions() Returns a set of the socket options supported by this channel.
public abstract SctpMultiChannel	Returns: This channel unbindAddress(InetAddress The address to remove from the bound addresses for the socket address) Removes the given address from the bound addresses for the channel's socket.
public final int	Returns: The valid-operation set validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations.

Inherited from java.nio.channels.spi.AbstractSelectableChannel:: blockingLock configureBlocking implCloseChannel implCloseSelectableChannel implConfigureBlocking isBlocking isRegistered keyFor provider register

SctpMultiChannel	back to summary
protected SctpMultiChannel(SelectorProvider provider) Initializes a new instance of this class. Parameters provider:SelectorProvider The selector provider for this channel

Method Detail

associations back to summary

associations	back to summary
public abstract Set<Association> associations() throws IOException Returns the open associations on this channel's socket. Only associations whose `COMM_UP` association change event has been received are included in the returned set of associations. Associations for which a `COMM_LOST` or `SHUTDOWN` association change event have been receive are removed from the set of associations. The returned set of associations is a snapshot of the open associations at the time that this method is invoked. Returns:Set<Association> A `Set` containing the open associations, or an empty `Set` if there are none. Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed

public abstract Set<Association> associations() throws IOException

Returns the open associations on this channel's socket.

Only associations whose COMM_UP association change event has been received are included in the returned set of associations. Associations for which a COMM_LOST or SHUTDOWN association change event have been receive are removed from the set of associations.

The returned set of associations is a snapshot of the open associations at the time that this method is invoked.

Returns:Set<Association>

A Set containing the open associations, or an empty Set if there are none.

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed

bind back to summary

bind	back to summary
public abstract SctpMultiChannel bind(SocketAddress local, int backlog) throws IOException Binds the channel's socket to a local address and configures the socket to listen for connections. This method is used to establish a relationship between the socket and the local address. Once a relationship is established then the socket remains bound until the channel is closed. This relationship may not necesssarily be with the address `local` as it may be removed by `unbindAddress`, but there will always be at least one local address bound to the channel's socket once an invocation of this method successfully completes. Once the channel's socket has been successfully bound to a specific address, that is not automatically assigned, more addresses may be bound to it using `bindAddress`, or removed using `unbindAddress`. The backlog parameter is the maximum number of pending connections on the socket. Its exact semantics are implementation specific. An implementation may impose an implementation specific maximum length or may choose to ignore the parameter. If the backlog parameter has the value `0`, or a negative value, then an implementation specific default is used. Parameters local:SocketAddress The local address to bind the socket, or `null` to bind the socket to an automatically assigned socket address backlog:int The maximum number of pending connections Returns:SctpMultiChannel This channel Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed AlreadyBoundException: If this channel is already bound UnsupportedAddressTypeException: If the type of the given address is not supported

public abstract SctpMultiChannel bind(SocketAddress local, int backlog) throws IOException

Binds the channel's socket to a local address and configures the socket to listen for connections.

This method is used to establish a relationship between the socket and the local address. Once a relationship is established then the socket remains bound until the channel is closed. This relationship may not necesssarily be with the address local as it may be removed by unbindAddress, but there will always be at least one local address bound to the channel's socket once an invocation of this method successfully completes.

Once the channel's socket has been successfully bound to a specific address, that is not automatically assigned, more addresses may be bound to it using bindAddress, or removed using unbindAddress.

The backlog parameter is the maximum number of pending connections on the socket. Its exact semantics are implementation specific. An implementation may impose an implementation specific maximum length or may choose to ignore the parameter. If the backlog parameter has the value 0, or a negative value, then an implementation specific default is used.

Parameters

local:SocketAddress: The local address to bind the socket, or null to bind the socket to an automatically assigned socket address
backlog:int: The maximum number of pending connections

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed
AlreadyBoundException:: If this channel is already bound
UnsupportedAddressTypeException:: If the type of the given address is not supported

bind back to summary

bind	back to summary
public final SctpMultiChannel bind(SocketAddress local) throws IOException Binds the channel's socket to a local address and configures the socket to listen for connections. This method works as if invoking it were equivalent to evaluating the expression: bind(local, 0); Parameters local:SocketAddress The local address to bind the socket, or `null` to bind the socket to an automatically assigned socket address Returns:SctpMultiChannel This channel Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed AlreadyBoundException: If this channel is already bound UnsupportedAddressTypeException: If the type of the given address is not supported

public final SctpMultiChannel bind(SocketAddress local) throws IOException

Binds the channel's socket to a local address and configures the socket to listen for connections.

This method works as if invoking it were equivalent to evaluating the expression:

bind(local, 0);

Parameters

local:SocketAddress: The local address to bind the socket, or null to bind the socket to an automatically assigned socket address

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed
AlreadyBoundException:: If this channel is already bound
UnsupportedAddressTypeException:: If the type of the given address is not supported

bindAddress back to summary

bindAddress	back to summary
public abstract SctpMultiChannel bindAddress(InetAddress address) throws IOException Adds the given address to the bound addresses for the channel's socket. The given address must not be the `wildcard` address. The channel must be first bound using `bind` before invoking this method, otherwise `NotYetBoundException` is thrown. The `bind` method takes a `SocketAddress` as its argument which typically contains a port number as well as an address. Addresses subquently bound using this method are simply addresses as the SCTP port number remains the same for the lifetime of the channel. New associations setup after this method successfully completes will be associated with the given address. Adding addresses to existing associations is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists. Parameters address:InetAddress The address to add to the bound addresses for the socket Returns:SctpMultiChannel This channel Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed NotYetBoundException: If this channel is not yet bound AlreadyBoundException: If this channel is already bound to the given address IllegalArgumentException: If address is `null` or the `wildcard` address

public abstract SctpMultiChannel bindAddress(InetAddress address) throws IOException

Adds the given address to the bound addresses for the channel's socket.

The given address must not be the wildcard address. The channel must be first bound using bind before invoking this method, otherwise NotYetBoundException is thrown. The bind method takes a SocketAddress as its argument which typically contains a port number as well as an address. Addresses subquently bound using this method are simply addresses as the SCTP port number remains the same for the lifetime of the channel.

New associations setup after this method successfully completes will be associated with the given address. Adding addresses to existing associations is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists.

Parameters

address:InetAddress: The address to add to the bound addresses for the socket

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed
NotYetBoundException:: If this channel is not yet bound
AlreadyBoundException:: If this channel is already bound to the given address
IllegalArgumentException:: If address is null or the wildcard address

branch back to summary

branch	back to summary
public abstract SctpChannel branch(Association association) throws IOException Branches off an association. An application can invoke this method to branch off an association into a separate channel. The new bound and connected `SctpChannel` will be created for the association. The branched off association will no longer be part of this channel. This is particularly useful when, for instance, the application wishes to have a number of sporadic message senders/receivers remain under the original SCTP multi channel but branch off those associations carrying high volume data traffic into their own separate SCTP channels. Parameters association:Association The association to branch off Returns:SctpChannel The `SctpChannel` Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed

public abstract SctpChannel branch(Association association) throws IOException

Branches off an association.

An application can invoke this method to branch off an association into a separate channel. The new bound and connected SctpChannel will be created for the association. The branched off association will no longer be part of this channel.

This is particularly useful when, for instance, the application wishes to have a number of sporadic message senders/receivers remain under the original SCTP multi channel but branch off those associations carrying high volume data traffic into their own separate SCTP channels.

Parameters

association:Association: The association to branch off

Returns:SctpChannel

The SctpChannel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed

getAllLocalAddresses back to summary

getAllLocalAddresses	back to summary
public abstract Set<SocketAddress> getAllLocalAddresses() throws IOException Returns all of the socket addresses to which this channel's socket is bound. Returns:Set<SocketAddress> All the socket addresses that this channel's socket is bound to, or an empty `Set` if the channel's socket is not bound Exceptions IOException: If an I/O error occurs ClosedChannelException: If the channel is closed

public abstract Set<SocketAddress> getAllLocalAddresses() throws IOException

Returns all of the socket addresses to which this channel's socket is bound.

Returns:Set<SocketAddress>

All the socket addresses that this channel's socket is bound to, or an empty Set if the channel's socket is not bound

Exceptions

IOException:: If an I/O error occurs
ClosedChannelException:: If the channel is closed

getOption back to summary

getOption	back to summary
public abstract <T> T getOption(SctpSocketOption<T> name, Association association) throws IOException Returns the value of a socket option. Note that some options are retrieved on the channel's socket, therefore the `association` parameter is not applicable and will be ignored if given. However, if the option is association specific then the association must be given. Parameters <T> The type of the socket option value name:SctpSocketOption<T> The socket option association:Association The association whose option should be retrieved, or `null` if this option should be retrieved at the channel's socket level. Returns:T The value of the socket option. A value of `null` may be a valid value for some socket options. Exceptions IOException: If an I/O error occurs UnsupportedOperationException: If the socket option is not supported by this channel ClosedChannelException: If this channel is closed See Also `SctpStandardSocketOptions`

public abstract <T> T getOption(SctpSocketOption<T> name, Association association) throws IOException

Returns the value of a socket option.

Note that some options are retrieved on the channel's socket, therefore the association parameter is not applicable and will be ignored if given. However, if the option is association specific then the association must be given.

Parameters

<T>: The type of the socket option value
name:SctpSocketOption<T>: The socket option
association:Association: The association whose option should be retrieved, or null if this option should be retrieved at the channel's socket level.

Returns:T

The value of the socket option. A value of null may be a valid value for some socket options.

Exceptions

IOException:: If an I/O error occurs
UnsupportedOperationException:: If the socket option is not supported by this channel
ClosedChannelException:: If this channel is closed

See Also

SctpStandardSocketOptions

getRemoteAddresses back to summary

getRemoteAddresses	back to summary
public abstract Set<SocketAddress> getRemoteAddresses(Association association) throws IOException Returns all of the remote addresses to which the given association on this channel's socket is connected. Parameters association:Association The association Returns:Set<SocketAddress> All of the remote addresses for the given association, or an empty `Set` if the association has been shutdown Exceptions IOException: If an I/O error occurs ClosedChannelException: If the channel is closed

public abstract Set<SocketAddress> getRemoteAddresses(Association association) throws IOException

Returns all of the remote addresses to which the given association on this channel's socket is connected.

Parameters

association:Association: The association

Returns:Set<SocketAddress>

All of the remote addresses for the given association, or an empty Set if the association has been shutdown

Exceptions

IOException:: If an I/O error occurs
ClosedChannelException:: If the channel is closed

open	back to summary
public static SctpMultiChannel open() throws IOException Opens an SCTP multi channel. The new channel is unbound. Returns:SctpMultiChannel A new SCTP multi channel Exceptions IOException: If an I/O error occurs UnsupportedOperationException: If the SCTP protocol is not supported

open

back to summary

public static SctpMultiChannel open() throws IOException

Opens an SCTP multi channel.

The new channel is unbound.

Returns:SctpMultiChannel

A new SCTP multi channel

Exceptions

IOException:: If an I/O error occurs
UnsupportedOperationException:: If the SCTP protocol is not supported

receive back to summary

receive	back to summary
public abstract <T> MessageInfo receive(ByteBuffer buffer, T attachment, NotificationHandler<T> handler) throws IOException Receives a message and/or handles a notification via this channel. If a message or notification is immediately available, or if this channel is in blocking mode and one eventually becomes available, then the message or notification is returned or handled, respectively. If this channel is in non-blocking mode and a message or notification is not immediately available then this method immediately returns `null`. If this method receives a message it is copied into the given byte buffer and an `MessageInfo` is returned. The message is transferred into the given byte buffer starting at its current position and the buffers position is incremented by the number of bytes read. If there are fewer bytes remaining in the buffer than are required to hold the message, or the underlying input buffer does not contain the complete message, then an invocation of `isComplete` on the returned `MessageInfo` will return `false`, and more invocations of this method will be necessary to completely consume the messgae. Only one message at a time will be partially delivered in any stream. The socket option `SCTP_FRAGMENT_INTERLEAVE` controls various aspects of what interlacing of messages occurs. If this method receives a notification then the appropriate method of the given handler, if there is one, is invoked. If the handler returns `CONTINUE` then this method will try to receive another message/notification, otherwise, if `RETURN` is returned this method will return `null`. If an uncaught exception is thrown by the handler it will be propagated up the stack through this method. This method may be invoked at any time. If another thread has already initiated a receive operation upon this channel, then an invocation of this method will block until the first operation is complete. The given handler is invoked without holding any locks used to enforce the above synchronization policy, that way handlers will not stall other threads from receiving. A handler should not invoke the `receive` method of this channel, if it does an `IllegalReceiveException` will be thrown. Parameters <T> The type of the attachment buffer:ByteBuffer The buffer into which bytes are to be transferred attachment:T The object to attach to the receive operation; can be `null` handler:NotificationHandler<T> A handler to handle notifications from the SCTP stack, or `null` to ignore any notifications. Returns:MessageInfo The `MessageInfo`, `null` if this channel is in non-blocking mode and no messages are immediately available or the notification handler returns `RETURN` after handling a notification Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed AsynchronousCloseException: If another thread closes this channel while the read operation is in progress ClosedByInterruptException: If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupted status NotYetBoundException: If this channel is not yet bound IllegalReceiveException: If the given handler invokes the `receive` method of this channel

public abstract <T> MessageInfo receive(ByteBuffer buffer, T attachment, NotificationHandler<T> handler) throws IOException

Receives a message and/or handles a notification via this channel.

If a message or notification is immediately available, or if this channel is in blocking mode and one eventually becomes available, then the message or notification is returned or handled, respectively. If this channel is in non-blocking mode and a message or notification is not immediately available then this method immediately returns null.

If this method receives a message it is copied into the given byte buffer and an MessageInfo is returned. The message is transferred into the given byte buffer starting at its current position and the buffers position is incremented by the number of bytes read. If there are fewer bytes remaining in the buffer than are required to hold the message, or the underlying input buffer does not contain the complete message, then an invocation of isComplete on the returned MessageInfo will return false, and more invocations of this method will be necessary to completely consume the messgae. Only one message at a time will be partially delivered in any stream. The socket option SCTP_FRAGMENT_INTERLEAVE controls various aspects of what interlacing of messages occurs.

If this method receives a notification then the appropriate method of the given handler, if there is one, is invoked. If the handler returns CONTINUE then this method will try to receive another message/notification, otherwise, if RETURN is returned this method will return null. If an uncaught exception is thrown by the handler it will be propagated up the stack through this method.

This method may be invoked at any time. If another thread has already initiated a receive operation upon this channel, then an invocation of this method will block until the first operation is complete. The given handler is invoked without holding any locks used to enforce the above synchronization policy, that way handlers will not stall other threads from receiving. A handler should not invoke the receive method of this channel, if it does an IllegalReceiveException will be thrown.

Parameters

<T>: The type of the attachment
buffer:ByteBuffer: The buffer into which bytes are to be transferred
attachment:T: The object to attach to the receive operation; can be null
handler:NotificationHandler<T>: A handler to handle notifications from the SCTP stack, or null to ignore any notifications.

Returns:MessageInfo

The MessageInfo, null if this channel is in non-blocking mode and no messages are immediately available or the notification handler returns RETURN after handling a notification

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed
AsynchronousCloseException:: If another thread closes this channel while the read operation is in progress
ClosedByInterruptException:: If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupted status
NotYetBoundException:: If this channel is not yet bound
IllegalReceiveException:: If the given handler invokes the receive method of this channel

send back to summary

send	back to summary
public abstract int send(ByteBuffer buffer, MessageInfo messageInfo) throws IOException Sends a message via this channel. If this channel is unbound then this method will invoke `bind(null, 0)` before sending any data. If there is no association existing between this channel's socket and the intended receiver, identified by the address in the given messageInfo, then one will be automatically setup to the intended receiver. This is considered to be Implicit Association Setup. Upon successful association setup, an `association changed` notification will be put to the SCTP stack with its `event` parameter set to `COMM_UP` . This notification can be received by invoking `receive`. If this channel is in blocking mode, there is sufficient room in the underlying output buffer, then the remaining bytes in the given byte buffer are transmitted as a single message. Sending a message is atomic unless explicit message completion `SCTP_EXPLICIT_COMPLETE` socket option is enabled on this channel's socket. If this channel is in non-blocking mode, there is sufficient room in the underlying output buffer, and an implicit association setup is required, then the remaining bytes in the given byte buffer are transmitted as a single message, subject to `SCTP_EXPLICIT_COMPLETE`. If for any reason the message cannot be delivered an `association changed` notification is put on the SCTP stack with its `event` parameter set to `CANT_START`. The message is transferred from the byte buffer as if by a regular `write` operation. This method may be invoked at any time. If another thread has already initiated a send operation upon this channel, then an invocation of this method will block until the first operation is complete. Parameters buffer:ByteBuffer The buffer containing the message to be sent messageInfo:MessageInfo Ancillary data about the message to be sent Returns:int The number of bytes sent, which will be either the number of bytes that were remaining in the messages buffer when this method was invoked or, if this channel is non-blocking, may be zero if there was insufficient room for the message in the underlying output buffer Exceptions IOException: If some other I/O error occurs InvalidStreamException: If `streamNumber` is negative, or if an association already exists and `streamNumber` is greater than the maximum number of outgoing streams ClosedChannelException: If this channel is closed AsynchronousCloseException: If another thread closes this channel while the read operation is in progress ClosedByInterruptException: If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupted status

public abstract int send(ByteBuffer buffer, MessageInfo messageInfo) throws IOException

Sends a message via this channel.

If this channel is unbound then this method will invoke bind(null, 0) before sending any data.

If there is no association existing between this channel's socket and the intended receiver, identified by the address in the given messageInfo, then one will be automatically setup to the intended receiver. This is considered to be Implicit Association Setup. Upon successful association setup, an association changed notification will be put to the SCTP stack with its event parameter set to COMM_UP . This notification can be received by invoking receive.

If this channel is in blocking mode, there is sufficient room in the underlying output buffer, then the remaining bytes in the given byte buffer are transmitted as a single message. Sending a message is atomic unless explicit message completion SCTP_EXPLICIT_COMPLETE socket option is enabled on this channel's socket.

If this channel is in non-blocking mode, there is sufficient room in the underlying output buffer, and an implicit association setup is required, then the remaining bytes in the given byte buffer are transmitted as a single message, subject to SCTP_EXPLICIT_COMPLETE. If for any reason the message cannot be delivered an association changed notification is put on the SCTP stack with its event parameter set to CANT_START.

The message is transferred from the byte buffer as if by a regular write operation.

This method may be invoked at any time. If another thread has already initiated a send operation upon this channel, then an invocation of this method will block until the first operation is complete.

Parameters

buffer:ByteBuffer: The buffer containing the message to be sent
messageInfo:MessageInfo: Ancillary data about the message to be sent

Returns:int

The number of bytes sent, which will be either the number of bytes that were remaining in the messages buffer when this method was invoked or, if this channel is non-blocking, may be zero if there was insufficient room for the message in the underlying output buffer

Exceptions

IOException:: If some other I/O error occurs
InvalidStreamException:: If streamNumber is negative, or if an association already exists and streamNumber is greater than the maximum number of outgoing streams
ClosedChannelException:: If this channel is closed
AsynchronousCloseException:: If another thread closes this channel while the read operation is in progress
ClosedByInterruptException:: If another thread interrupts the current thread while the read operation is in progress, thereby closing the channel and setting the current thread's interrupted status

setOption back to summary

setOption	back to summary
public abstract <T> SctpMultiChannel setOption(SctpSocketOption<T> name, T value, Association association) throws IOException Sets the value of a socket option. Note that some options are retrieved on the channel's socket, therefore the `association` parameter is not applicable and will be ignored if given. However, if the option is association specific then the association must be given. Parameters <T> The type of the socket option value name:SctpSocketOption<T> The socket option value:T The value of the socket option. A value of `null` may be a valid value for some socket options. association:Association The association whose option should be set, or `null` if this option should be set at the channel's socket level. Returns:SctpMultiChannel This channel Exceptions IOException: If an I/O error occurs UnsupportedOperationException: If the socket option is not supported by this channel IllegalArgumentException: If the value is not a valid value for this socket option ClosedChannelException: If this channel is closed See Also `SctpStandardSocketOptions`

public abstract <T> SctpMultiChannel setOption(SctpSocketOption<T> name, T value, Association association) throws IOException

Sets the value of a socket option.

Parameters

<T>: The type of the socket option value
name:SctpSocketOption<T>: The socket option
value:T: The value of the socket option. A value of null may be a valid value for some socket options.
association:Association: The association whose option should be set, or null if this option should be set at the channel's socket level.

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If an I/O error occurs
UnsupportedOperationException:: If the socket option is not supported by this channel
IllegalArgumentException:: If the value is not a valid value for this socket option
ClosedChannelException:: If this channel is closed

See Also

SctpStandardSocketOptions

shutdown	back to summary
public abstract SctpMultiChannel shutdown(Association association) throws IOException Shutdown an association without closing the channel. Parameters association:Association The association to shutdown Returns:SctpMultiChannel This channel Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed

shutdown

back to summary

public abstract SctpMultiChannel shutdown(Association association) throws IOException

Shutdown an association without closing the channel.

Parameters

association:Association: The association to shutdown

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed

supportedOptions	back to summary
public abstract Set<SctpSocketOption<?>> supportedOptions() Returns a set of the socket options supported by this channel. This method will continue to return the set of options even after the channel has been closed. Returns:Set<SctpSocketOption<?>> A set of the socket options supported by this channel

supportedOptions

back to summary

public abstract Set<SctpSocketOption<?>> supportedOptions()

Returns a set of the socket options supported by this channel.

This method will continue to return the set of options even after the channel has been closed.

Returns:Set<SctpSocketOption<?>>: A set of the socket options supported by this channel

unbindAddress back to summary

unbindAddress	back to summary
public abstract SctpMultiChannel unbindAddress(InetAddress address) throws IOException Removes the given address from the bound addresses for the channel's socket. The given address must not be the `wildcard` address. The channel must be first bound using `bind` before invoking this method, otherwise `NotYetBoundException` is thrown. If this method is invoked on a channel that does not have `address` as one of its bound addresses, or that has only one local address bound to it, then this method throws `IllegalUnbindException`. The initial address that the channel's socket is bound to using `bind` may be removed from the bound addresses for the channel's socket. New associations setup after this method successfully completes will not be associated with the given address. Removing addresses from existing associations is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists. Parameters address:InetAddress The address to remove from the bound addresses for the socket Returns:SctpMultiChannel This channel Exceptions IOException: If some other I/O error occurs ClosedChannelException: If this channel is closed NotYetBoundException: If this channel is not yet bound IllegalUnbindException: `address` is not bound to the channel's socket, or the channel has only one address bound to it IllegalArgumentException: If address is `null` or the `wildcard` address

public abstract SctpMultiChannel unbindAddress(InetAddress address) throws IOException

Removes the given address from the bound addresses for the channel's socket.

The given address must not be the wildcard address. The channel must be first bound using bind before invoking this method, otherwise NotYetBoundException is thrown.

If this method is invoked on a channel that does not have address as one of its bound addresses, or that has only one local address bound to it, then this method throws IllegalUnbindException.

The initial address that the channel's socket is bound to using bind may be removed from the bound addresses for the channel's socket.

New associations setup after this method successfully completes will not be associated with the given address. Removing addresses from existing associations is optional functionality. If the endpoint supports dynamic address reconfiguration then it may send the appropriate message to the peer to change the peers address lists.

Parameters

address:InetAddress: The address to remove from the bound addresses for the socket

Returns:SctpMultiChannel

This channel

Exceptions

IOException:: If some other I/O error occurs
ClosedChannelException:: If this channel is closed
NotYetBoundException:: If this channel is not yet bound
IllegalUnbindException:: address is not bound to the channel's socket, or the channel has only one address bound to it
IllegalArgumentException:: If address is null or the wildcard address

validOps back to summary

validOps	back to summary
public final int validOps() Implements abstract java.nio.channels.SelectableChannel.validOps. Returns an operation set identifying this channel's supported operations. SCTP multi channels support reading, and writing, so this method returns `(SelectionKey#OP_READ` `\|` `SelectionKey#OP_WRITE)`. Returns:int The valid-operation set Annotations @Override

public final int validOps()

Implements abstract java.nio.channels.SelectableChannel.validOps.

Returns an operation set identifying this channel's supported operations.

SCTP multi channels support reading, and writing, so this method returns (SelectionKey#OP_READ | SelectionKey#OP_WRITE).

Returns:int

The valid-operation set

Annotations

@Override

public abstract Class SctpMultiChannel

Constructor Summary

Method Summary

Constructor Detail

Method Detail