FileDocCategorySizeDatePackage
ServerSocketChannel.javaAPI DocJava SE 5 API5653Fri Aug 26 14:57:10 BST 2005java.nio.channels

ServerSocketChannel

public abstract class ServerSocketChannel extends AbstractSelectableChannel
A selectable channel for stream-oriented listening sockets.

Server-socket channels are not a complete abstraction of listening network sockets. Binding and the manipulation of socket options must be done through an associated {@link java.net.ServerSocket} object obtained by invoking the {@link #socket() socket} method. It is not possible to create a channel for an arbitrary, pre-existing server socket, nor is it possible to specify the {@link java.net.SocketImpl} object to be used by a server socket associated with a server-socket channel.

A server-socket channel is created by invoking the {@link #open() open} method of this class. A newly-created server-socket channel is open but not yet bound. An attempt to invoke the {@link #accept() accept} method of an unbound server-socket channel will cause a {@link NotYetBoundException} to be thrown. A server-socket channel can be bound by invoking one of the {@link java.net.ServerSocket#bind(java.net.SocketAddress,int) bind} methods of an associated server socket.

Server-socket channels are safe for use by multiple concurrent threads.

author
Mark Reinhold
author
JSR-51 Expert Group
version
1.24, 03/12/19
since
1.4

Fields Summary
Constructors Summary
protected ServerSocketChannel(SelectorProvider provider)
Initializes a new instance of this class.

	super(provider);
    
Methods Summary
public abstract java.nio.channels.SocketChannelaccept()
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.

This method performs exactly the same security checks as the {@link java.net.ServerSocket#accept accept} method of the {@link java.net.ServerSocket} class. That is, if a security manager has been installed then for each new connection this method verifies that the address and port number of the connection's remote endpoint are permitted by the security manager's {@link java.lang.SecurityManager#checkAccept checkAccept} method.

return
The socket channel for the new connection, or null if this channel is in non-blocking mode and no connection is available to be accepted
throws
ClosedChannelException If this channel is closed
throws
AsynchronousCloseException If another thread closes this channel while the accept operation is in progress
throws
ClosedByInterruptException 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 status
throws
NotYetBoundException If this channel's socket has not yet been bound
throws
SecurityException If a security manager has been installed and it does not permit access to the remote endpoint of the new connection
throws
IOException If some other I/O error occurs

public static java.nio.channels.ServerSocketChannelopen()
Opens a server-socket channel.

The new channel is created by invoking the {@link java.nio.channels.spi.SelectorProvider#openServerSocketChannel openServerSocketChannel} method of the system-wide default {@link java.nio.channels.spi.SelectorProvider} object.

The new channel's socket is initially unbound; it must be bound to a specific address via one of its socket's {@link java.net.ServerSocket#bind(SocketAddress) bind} methods before connections can be accepted.

return
A new socket channel
throws
IOException If an I/O error occurs

	return SelectorProvider.provider().openServerSocketChannel();
    
public abstract java.net.ServerSocketsocket()
Retrieves a server socket associated with this channel.

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

return
A server socket associated with this channel

public final intvalidOps()
Returns an operation set identifying this channel's supported operations.

Server-socket channels only support the accepting of new connections, so this method returns {@link SelectionKey#OP_ACCEPT}.

return
The valid-operation set

	return SelectionKey.OP_ACCEPT;