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

Modifier and Type	Class and Description
private static class	ServerSocketChannelImpl.DefaultOptionsHolder

Modifier and Type	Field and Description
private final ReentrantLock	acceptLock
private final ProtocolFamily	family
private final FileDescriptor	fd
private final int	fdVal
private volatile boolean	forcedNonBlocking
private boolean	isReuseAddress
private SocketAddress	localAddress
private static final NativeDispatcher	nd
private ServerSocket	socket
private static final int	ST_CLOSED
private static final int	ST_CLOSING
private static final int	ST_INUSE
private int	state
private final Object	stateLock
private Thread	thread

Access	Constructor and Description
pack-priv	ServerSocketChannelImpl(SelectorProvider sp)
pack-priv	ServerSocketChannelImpl(SelectorProvider sp, ProtocolFamily family)
pack-priv	ServerSocketChannelImpl(SelectorProvider sp, ProtocolFamily family, FileDescriptor fd, boolean bound)

Method Summary

Modifier and Type	Method and Description
public SocketChannel	accept() Implements abstract java.nio.channels.ServerSocketChannel.accept. Accepts a connection made to this channel's socket.
private void	begin(boolean blocking) Marks the beginning of an I/O operation that might block.
public ServerSocketChannel	bind(SocketAddress local, int backlog) Implements abstract java.nio.channels.ServerSocketChannel.bind. Binds the channel's socket to a local address and configures the socket to listen for connections.
pack-priv SocketChannel	blockingAccept(long the timeout, in nanoseconds nanos) Accepts a new connection with a given timeout.
private void	configureSocketNonBlockingIfVirtualThread() Ensures that the socket is configured non-blocking when on a virtual thread.
private void	end(boolean blocking, boolean completed) Marks the end of an I/O operation that may have blocked.
private void	ensureOpen()
private SocketChannel	finishAccept(FileDescriptor newfd, SocketAddress sa)
public FileDescriptor	getFD() Implements sun.nio.ch.SelChImpl.getFD.
public int	getFDVal() Implements sun.nio.ch.SelChImpl.getFDVal.
public SocketAddress	getLocalAddress() Implements abstract java.nio.channels.ServerSocketChannel.getLocalAddress. Implements java.nio.channels.NetworkChannel.getLocalAddress. Returns the socket address that this channel's socket is bound to.
public <T> T	getOption(SocketOption<T> name) Implements java.nio.channels.NetworkChannel.getOption. Returns the value of a socket option.
private int	implAccept(FileDescriptor fd, FileDescriptor newfd, SocketAddress[] saa)
private void	implCloseBlockingMode() Closes this channel when configured in blocking mode.
private void	implCloseNonBlockingMode() Closes this channel when configured in non-blocking mode.
protected void	implCloseSelectableChannel() Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. Invoked by implCloseChannel to close the channel.
protected void	implConfigureBlocking(boolean block) Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Adjusts this channel's blocking mode.
pack-priv boolean	isBound() Returns true if channel's socket is bound
private boolean	isNetSocket() Returns true if this channel is to a INET or INET6 socket.
pack-priv boolean	isUnixSocket() Returns true if this channel is to a UNIX socket.
public void	kill() Implements sun.nio.ch.SelChImpl.kill.
pack-priv SocketAddress	localAddress() Returns the local address, or null if not bound
private void	lockedConfigureBlocking(boolean block) Adjusts the blocking mode.
private SocketAddress	netBind(SocketAddress local, int backlog)
public <T> ServerSocketChannel	setOption(SocketOption<T> name, T value) Implements abstract java.nio.channels.ServerSocketChannel.setOption. Implements java.nio.channels.NetworkChannel.setOption. Sets the value of a socket option.
public ServerSocket	socket() Implements abstract java.nio.channels.ServerSocketChannel.socket. Retrieves a server socket associated with this channel.
public final Set<SocketOption<?>>	supportedOptions() Implements java.nio.channels.NetworkChannel.supportedOptions. Returns a set of the socket options supported by this channel.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public boolean	translateAndSetReadyOps(int ops, SelectionKeyImpl ski) Implements sun.nio.ch.SelChImpl.translateAndSetReadyOps. Sets the specified ops if present in interestOps.
public boolean	translateAndUpdateReadyOps(int ops, SelectionKeyImpl ski) Implements sun.nio.ch.SelChImpl.translateAndUpdateReadyOps. Adds the specified ops if present in interestOps.
public int	translateInterestOps(int ops) Implements sun.nio.ch.SelChImpl.translateInterestOps. Translates an interest operation set into a native poll event set
public boolean	translateReadyOps(int ops, int initialOps, SelectionKeyImpl ski) Translates native poll revent set into a ready operation set
private boolean	tryClose() Closes the socket if there are no accept in progress and the channel is not registered with a Selector.
private void	tryFinishClose() Invokes tryClose to attempt to close the socket.
private boolean	Returns: `true` if the blocking mode was adjusted tryLockedConfigureBlocking(boolean block) Attempts to adjust the blocking mode if the channel is open.
private SocketAddress	unixBind(SocketAddress local, int backlog)

Inherited from java.nio.channels.ServerSocketChannel:: bind open open validOps

acceptLock	back to summary
private final ReentrantLock acceptLock

family	back to summary
private final ProtocolFamily family

fd	back to summary
private final FileDescriptor fd

fdVal	back to summary
private final int fdVal

forcedNonBlocking	back to summary
private volatile boolean forcedNonBlocking

isReuseAddress	back to summary
private boolean isReuseAddress

localAddress	back to summary
private SocketAddress localAddress

nd	back to summary
private static final NativeDispatcher nd

socket	back to summary
private ServerSocket socket

ST_CLOSED	back to summary
private static final int ST_CLOSED

ST_CLOSING	back to summary
private static final int ST_CLOSING

ST_INUSE	back to summary
private static final int ST_INUSE

state	back to summary
private int state

stateLock	back to summary
private final Object stateLock

thread	back to summary
private Thread thread

ServerSocketChannelImpl	back to summary
pack-priv ServerSocketChannelImpl(SelectorProvider sp) throws IOException

ServerSocketChannelImpl	back to summary
pack-priv ServerSocketChannelImpl(SelectorProvider sp, ProtocolFamily family) throws IOException

ServerSocketChannelImpl	back to summary
pack-priv ServerSocketChannelImpl(SelectorProvider sp, ProtocolFamily family, FileDescriptor fd, boolean bound) throws IOException

Method Detail

accept back to summary

accept	back to summary
public SocketChannel accept() throws IOException Implements abstract java.nio.channels.ServerSocketChannel.accept. Doc from java.nio.channels.ServerSocketChannel.accept. Accepts a connection made to this channel's socket. If this channel is in non-blocking mode then this method will immediately return `null` if there are no pending connections. Otherwise it will block indefinitely until a new connection is available or an I/O error occurs. The socket channel returned by this method, if any, will be in blocking mode regardless of the blocking mode of this channel. Annotations @Override Exceptions IOException: If some other I/O error occurs

public SocketChannel accept() throws IOException

Implements abstract java.nio.channels.ServerSocketChannel.accept.

Doc from java.nio.channels.ServerSocketChannel.accept.

Accepts a connection made to this channel's socket.

If this channel is in non-blocking mode then this method will immediately return null if there are no pending connections. Otherwise it will block indefinitely until a new connection is available or an I/O error occurs.

The socket channel returned by this method, if any, will be in blocking mode regardless of the blocking mode of this channel.

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

begin	back to summary
private void begin(boolean blocking) throws ClosedChannelException Marks the beginning of an I/O operation that might block. Exceptions ClosedChannelException: if the channel is closed NotYetBoundException: if the channel's socket has not been bound yet

begin

back to summary

private void begin(boolean blocking) throws ClosedChannelException

Marks the beginning of an I/O operation that might block.

Exceptions

ClosedChannelException:: if the channel is closed
NotYetBoundException:: if the channel's socket has not been bound yet

bind back to summary

bind	back to summary
public ServerSocketChannel bind(SocketAddress local, int backlog) throws IOException Implements abstract java.nio.channels.ServerSocketChannel.bind. Doc from java.nio.channels.ServerSocketChannel.bind. Binds the channel's socket to a local address and configures the socket to listen for connections. This method is used to establish an association between the socket and a local address. For Internet protocol sockets, once an association is established then the socket remains bound until the channel is closed. The `backlog` parameter is the maximum number of pending connections on the socket. Its exact semantics are implementation specific. In particular, an implementation may impose a maximum length or may choose to ignore the parameter altogether. If the `backlog` parameter has the value `0`, or a negative value, then an implementation specific default is used. Annotations @Override Exceptions IOException: If some other I/O error occurs

public ServerSocketChannel bind(SocketAddress local, int backlog) throws IOException

Implements abstract java.nio.channels.ServerSocketChannel.bind.

Doc from java.nio.channels.ServerSocketChannel.bind.

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

This method is used to establish an association between the socket and a local address. For Internet protocol sockets, once an association is established then the socket remains bound until the channel is closed.

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

Annotations

@Override

Exceptions

IOException:: If some other I/O error occurs

blockingAccept	back to summary
pack-priv SocketChannel blockingAccept(long nanos) throws IOException Accepts a new connection with a given timeout. This method requires the channel to be configured in blocking mode. API Note This method is for use by the socket adaptor. Parameters nanos:long the timeout, in nanoseconds Exceptions IllegalBlockingModeException: if the channel is configured non-blocking SocketTimeoutException: if the timeout expires

blockingAccept

back to summary

pack-priv SocketChannel blockingAccept(long nanos) throws IOException

Accepts a new connection with a given timeout. This method requires the channel to be configured in blocking mode.

API Note

This method is for use by the socket adaptor.

Parameters

nanos:long: the timeout, in nanoseconds

Exceptions

IllegalBlockingModeException:: if the channel is configured non-blocking
SocketTimeoutException:: if the timeout expires

configureSocketNonBlockingIfVirtualThread	back to summary
private void configureSocketNonBlockingIfVirtualThread() throws IOException Ensures that the socket is configured non-blocking when on a virtual thread.

end	back to summary
private void end(boolean blocking, boolean completed) throws AsynchronousCloseException Marks the end of an I/O operation that may have blocked. Exceptions AsynchronousCloseException: if the channel was closed due to this thread being interrupted on a blocking I/O operation.

end

back to summary

private void end(boolean blocking, boolean completed) throws AsynchronousCloseException

Marks the end of an I/O operation that may have blocked.

Exceptions

AsynchronousCloseException:: if the channel was closed due to this thread being interrupted on a blocking I/O operation.

ensureOpen	back to summary
private void ensureOpen() throws ClosedChannelException

finishAccept	back to summary
private SocketChannel finishAccept(FileDescriptor newfd, SocketAddress sa) throws IOException

getFD	back to summary
public FileDescriptor getFD() Implements sun.nio.ch.SelChImpl.getFD.

getFDVal	back to summary
public int getFDVal() Implements sun.nio.ch.SelChImpl.getFDVal.

getLocalAddress back to summary

getLocalAddress	back to summary
public SocketAddress getLocalAddress() throws IOException Implements abstract java.nio.channels.ServerSocketChannel.getLocalAddress. Implements java.nio.channels.NetworkChannel.getLocalAddress. Doc from java.nio.channels.ServerSocketChannel.getLocalAddress. Returns the socket address that this channel's socket is bound to. Where the channel is `bound` to an Internet Protocol socket address then the return value from this method is of type `java.net.InetSocketAddress`. Where the channel is bound to a Unix Domain socket address, the socket address is a `UnixDomainSocketAddress`. Annotations @Override Exceptions IOException: If an I/O error occurs

public SocketAddress getLocalAddress() throws IOException

Implements abstract java.nio.channels.ServerSocketChannel.getLocalAddress.

Implements java.nio.channels.NetworkChannel.getLocalAddress.

Doc from java.nio.channels.ServerSocketChannel.getLocalAddress.

Returns the socket address that this channel's socket is bound to.

Where the channel is bound to an Internet Protocol socket address then the return value from this method is of type java.net.InetSocketAddress.

Where the channel is bound to a Unix Domain socket address, the socket address is a UnixDomainSocketAddress.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getOption	back to summary
public <T> T getOption(SocketOption<T> name) throws IOException Implements java.nio.channels.NetworkChannel.getOption. Doc from java.nio.channels.NetworkChannel.getOption. Returns the value of a socket option. Annotations @Override @SuppressWarnings:unchecked Exceptions IOException: If an I/O error occurs

getOption

back to summary

public <T> T getOption(SocketOption<T> name) throws IOException

Implements java.nio.channels.NetworkChannel.getOption.

Doc from java.nio.channels.NetworkChannel.getOption.

Returns the value of a socket option.

Annotations

@Override
@SuppressWarnings:unchecked

Exceptions

IOException:: If an I/O error occurs

implAccept	back to summary
private int implAccept(FileDescriptor fd, FileDescriptor newfd, SocketAddress[] saa) throws IOException

implCloseBlockingMode	back to summary
private void implCloseBlockingMode() throws IOException Closes this channel when configured in blocking mode. If there is an accept in progress then the socket is pre-closed and the accept thread is signalled, in which case the final close is deferred until the accept aborts.

implCloseNonBlockingMode	back to summary
private void implCloseNonBlockingMode() throws IOException Closes this channel when configured in non-blocking mode. If the channel is registered with a Selector then the close is deferred until the channel is flushed from all Selectors.

implCloseSelectableChannel	back to summary
protected void implCloseSelectableChannel() throws IOException Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. Invoked by implCloseChannel to close the channel. Annotations @Override Exceptions IOException: Doc from java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel. If an I/O error occurs

implCloseSelectableChannel

back to summary

protected void implCloseSelectableChannel() throws IOException

Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel.

Invoked by implCloseChannel to close the channel.

Annotations

@Override

Exceptions

IOException:

Doc from java.nio.channels.spi.AbstractSelectableChannel.implCloseSelectableChannel.

If an I/O error occurs

implConfigureBlocking back to summary

implConfigureBlocking	back to summary
protected void implConfigureBlocking(boolean block) throws IOException Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Doc from java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking. Adjusts this channel's blocking mode. This method is invoked by the `configureBlocking` method in order to perform the actual work of changing the blocking mode. This method is only invoked if the new mode is different from the current mode. Annotations @Override Exceptions IOException: If an I/O error occurs

protected void implConfigureBlocking(boolean block) throws IOException

Implements abstract java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking.

Doc from java.nio.channels.spi.AbstractSelectableChannel.implConfigureBlocking.

Adjusts this channel's blocking mode.

This method is invoked by the configureBlocking method in order to perform the actual work of changing the blocking mode. This method is only invoked if the new mode is different from the current mode.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

isBound	back to summary
pack-priv boolean isBound() Returns true if channel's socket is bound

isNetSocket	back to summary
private boolean isNetSocket() Returns true if this channel is to a INET or INET6 socket.

isUnixSocket	back to summary
pack-priv boolean isUnixSocket() Returns true if this channel is to a UNIX socket.

kill	back to summary
public void kill() Implements sun.nio.ch.SelChImpl.kill. Annotations @Override

kill

back to summary

public void kill()

Implements sun.nio.ch.SelChImpl.kill.

Annotations

@Override

localAddress	back to summary
pack-priv SocketAddress localAddress() Returns the local address, or null if not bound

lockedConfigureBlocking	back to summary
private void lockedConfigureBlocking(boolean block) throws IOException Adjusts the blocking mode.

netBind	back to summary
private SocketAddress netBind(SocketAddress local, int backlog) throws IOException

setOption	back to summary
public <T> ServerSocketChannel setOption(SocketOption<T> name, T value) throws IOException Implements abstract java.nio.channels.ServerSocketChannel.setOption. Implements java.nio.channels.NetworkChannel.setOption. Doc from java.nio.channels.NetworkChannel.setOption. Sets the value of a socket option. Annotations @Override Exceptions IOException: Doc from java.nio.channels.ServerSocketChannel.setOption. If an I/O error occurs

setOption

back to summary

public <T> ServerSocketChannel setOption(SocketOption<T> name, T value) throws IOException

Implements abstract java.nio.channels.ServerSocketChannel.setOption.

Implements java.nio.channels.NetworkChannel.setOption.

Doc from java.nio.channels.NetworkChannel.setOption.

Sets the value of a socket option.

Annotations

@Override

Exceptions

IOException:

Doc from java.nio.channels.ServerSocketChannel.setOption.

If an I/O error occurs

socket back to summary

socket	back to summary
public ServerSocket socket() Implements abstract java.nio.channels.ServerSocketChannel.socket. Doc from java.nio.channels.ServerSocketChannel.socket. Retrieves a server socket associated with this channel. The returned object will not declare any public methods that are not declared in the `java.net.ServerSocket` class. Annotations @Override

public ServerSocket socket()

Implements abstract java.nio.channels.ServerSocketChannel.socket.

Doc from java.nio.channels.ServerSocketChannel.socket.

Retrieves a server socket associated with this channel.

The returned object will not declare any public methods that are not declared in the java.net.ServerSocket class.

Annotations

@Override

supportedOptions	back to summary
public final Set<SocketOption<?>> supportedOptions() Implements java.nio.channels.NetworkChannel.supportedOptions. Doc from java.nio.channels.NetworkChannel.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. Annotations @Override

supportedOptions

back to summary

public final Set<SocketOption<?>> supportedOptions()

Implements java.nio.channels.NetworkChannel.supportedOptions.

Doc from java.nio.channels.NetworkChannel.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.

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.

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.

translateAndSetReadyOps

back to summary

public boolean translateAndSetReadyOps(int ops, SelectionKeyImpl ski)

Implements sun.nio.ch.SelChImpl.translateAndSetReadyOps.

Doc from sun.nio.ch.SelChImpl.translateAndSetReadyOps.

Sets the specified ops if present in interestOps. The specified ops are turned on, and all other ops are turned off.

translateAndUpdateReadyOps

back to summary

public boolean translateAndUpdateReadyOps(int ops, SelectionKeyImpl ski)

Implements sun.nio.ch.SelChImpl.translateAndUpdateReadyOps.

Doc from sun.nio.ch.SelChImpl.translateAndUpdateReadyOps.

Adds the specified ops if present in interestOps. The specified ops are turned on without affecting the other ops.

translateInterestOps

back to summary

public int translateInterestOps(int ops)

Implements sun.nio.ch.SelChImpl.translateInterestOps.

Translates an interest operation set into a native poll event set

translateReadyOps	back to summary
public boolean translateReadyOps(int ops, int initialOps, SelectionKeyImpl ski) Translates native poll revent set into a ready operation set

tryClose	back to summary
private boolean tryClose() throws IOException Closes the socket if there are no accept in progress and the channel is not registered with a Selector.

tryFinishClose	back to summary
private void tryFinishClose() Invokes tryClose to attempt to close the socket. This method is used for deferred closing by I/O and Selector operations.

tryLockedConfigureBlocking back to summary

private boolean tryLockedConfigureBlocking(boolean block) throws IOException

Attempts to adjust the blocking mode if the channel is open.

Returns:boolean: true if the blocking mode was adjusted

unixBind	back to summary
private SocketAddress unixBind(SocketAddress local, int backlog) throws IOException

Modifier and Type	Field and Description
pack-priv static final Set<SocketOption<?>>	defaultInetOptions
pack-priv static final Set<SocketOption<?>>	defaultUnixDomainOptions

Modifier and Type	Method and Description
private static Set<SocketOption<?>>	defaultInetOptions()
private static Set<SocketOption<?>>	defaultUnixDomainOptions()

pack-priv Class ServerSocketChannelImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ServerSocketChannelImpl.DefaultOptionsHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail