Closeable, AutoCloseable, Channel, InterruptibleChannel
public abstract class SctpServerChannel extends AbstractSelectableChannel
An SCTPServerChannel is created by invoking the open method of this class. A newly-created SCTP server channel is open but not yet bound. An attempt to invoke the accept method of an unbound channel will cause the NotYetBoundException to be thrown. An SCTP server channel can be bound by invoking one of the bind methods defined by this class.
Socket options are configured using the setOption method. SCTP server socket channels support the following options:
Additional (implementation specific) options may also be supported. The list of options supported is obtained by invoking the
Option Name Description SCTP_INIT_MAXSTREAMSThe maximum number of streams requested by the local endpoint during association initialization
supportedOptions method. SCTP server channels are safe for use by multiple concurrent threads.
| Modifier | Constructor | Description |
|---|---|---|
protected |
Initializes a new instance of this class. |
| Modifier and Type | Method | Description |
|---|---|---|
abstract SctpChannel |
accept() |
Accepts an association on this channel's socket. |
final SctpServerChannel |
bind |
Binds the channel's socket to a local address and configures the socket to listen for associations. |
abstract SctpServerChannel |
bind |
Binds the channel's socket to a local address and configures the socket to listen for associations. |
abstract SctpServerChannel |
bindAddress |
Adds the given address to the bound addresses for the channel's socket. |
abstract Set |
getAllLocalAddresses() |
Returns all of the socket addresses to which this channel's socket is bound. |
abstract <T> T |
getOption |
Returns the value of a socket option. |
static SctpServerChannel |
open() |
Opens an SCTP server channel. |
abstract <T> SctpServerChannel |
setOption |
Sets the value of a socket option. |
abstract Set |
supportedOptions() |
Returns a set of the socket options supported by this channel. |
abstract SctpServerChannel |
unbindAddress |
Removes the given address from the bound addresses for the channel's socket. |
final int |
validOps() |
Returns an operation set identifying this channel's supported operations. |
blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register
register
begin, close, end, isOpen
protected SctpServerChannel(SelectorProvider provider)
provider - The selector provider for this channelpublic static SctpServerChannel open() throws IOException
The new channel's socket is initially unbound; it must be bound to a specific address via one of its socket's bind methods before associations can be accepted.
UnsupportedOperationException - If the SCTP protocol is not supportedIOException - If an I/O error occurspublic abstract SctpChannel accept() throws IOException
If this channel is in non-blocking mode then this method will immediately return null if there are no pending associations. Otherwise it will block indefinitely until a new association is available or an I/O error occurs.
The SCTPChannel returned by this method, if any, will be in blocking mode regardless of the blocking mode of this channel.
If a security manager has been installed then for each new association this method verifies that the address and port number of the assocaitions's remote peer are permitted by the security manager's checkAccept method.
null if this channel is in non-blocking mode and no association is available to be acceptedClosedChannelException - If this channel is closedAsynchronousCloseException - If another thread closes this channel while the accept operation is in progressClosedByInterruptException - If another thread interrupts the current thread while the accept operation is in progress, thereby closing the channel and setting the current thread's interrupt statusNotYetBoundException - If this channel's socket has not yet been boundSecurityException - If a security manager has been installed and it does not permit access to the remote peer of the new associationIOException - If some other I/O error occurspublic final SctpServerChannel bind(SocketAddress local) throws IOException
This method works as if invoking it were equivalent to evaluating the expression:
bind(local, 0);
local - The local address to bind the socket, or null to bind the socket to an automatically assigned socket addressClosedChannelException - If this channel is closedAlreadyBoundException - If this channel is already boundUnsupportedAddressTypeException - If the type of the given address is not supportedSecurityException - If a security manager has been installed and its checkListen method denies the operationIOException - If some other I/O error occurspublic abstract SctpServerChannel bind(SocketAddress local, int backlog) throws IOException
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 associations 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.
local - The local address to bind the socket, or null to bind the socket to an automatically assigned socket addressbacklog - The maximum number of pending associationsClosedChannelException - If this channel is closedAlreadyBoundException - If this channel is already boundUnsupportedAddressTypeException - If the type of the given address is not supportedSecurityException - If a security manager has been installed and its checkListen method denies the operationIOException - If some other I/O error occurspublic abstract SctpServerChannel bindAddress(InetAddress address) throws IOException
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 accepted after this method successfully completes will be associated with the given address.
address - The address to add to the bound addresses for the socketClosedChannelException - If this channel is closedNotYetBoundException - If this channel is not yet boundAlreadyBoundException - If this channel is already bound to the given addressIllegalArgumentException - If address is null or the wildcard addressIOException - If some other I/O error occurspublic abstract SctpServerChannel unbindAddress(InetAddress address) throws IOException
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 accepted after this method successfully completes will not be associated with the given address.
address - The address to remove from the bound addresses for the socketClosedChannelException - If this channel is closedNotYetBoundException - If this channel is not yet boundIllegalArgumentException - If address is null or the wildcard addressIllegalUnbindException - If the implementation does not support removing addresses from a listening socket, address is not bound to the channel's socket, or the channel has only one address bound to itIOException - If some other I/O error occurspublic abstract Set<SocketAddress> getAllLocalAddresses() throws IOException
Set if the channel's socket is not boundClosedChannelException - If the channel is closedIOException - If an I/O error occurspublic abstract <T> T getOption(SctpSocketOption<T> name) throws IOException
T - The type of the socket option valuename - The socket optionnull may be a valid value for some socket options.UnsupportedOperationException - If the socket option is not supported by this channelClosedChannelException - If this channel is closedIOException - If an I/O error occurspublic abstract <T> SctpServerChannel setOption(SctpSocketOption<T> name, T value) throws IOException
T - The type of the socket option valuename - The socket optionvalue - The value of the socket option. A value of null may be a valid value for some socket options.UnsupportedOperationException - If the socket option is not supported by this channelIllegalArgumentException - If the value is not a valid value for this socket optionClosedChannelException - If this channel is closedIOException - If an I/O error occurspublic abstract Set<SctpSocketOption<?>> supportedOptions()
This method will continue to return the set of options even after the channel has been closed.
public final int validOps()
SCTP server channels only support the accepting of new associations, so this method returns SelectionKey.OP_ACCEPT.
validOps in class SelectableChannel
© 1993, 2023, 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/21/docs/api/jdk.sctp/com/sun/nio/sctp/SctpServerChannel.html