Save This Page
Home » openjdk-7 » java » nio » channels » [javadoc | source]
java.nio.channels
abstract public class: ServerSocketChannel [javadoc | source]
java.lang.Object
   java.nio.channels.spi.AbstractInterruptibleChannel
      java.nio.channels.SelectableChannel
         java.nio.channels.spi.AbstractSelectableChannel
            java.nio.channels.ServerSocketChannel

All Implemented Interfaces:
    NetworkChannel, Channel, InterruptibleChannel

A selectable channel for stream-oriented listening sockets.

A server-socket channel is created by invoking the open method of this class. It is not possible to create a channel for an arbitrary, pre-existing ServerSocket . A newly-created server-socket channel is open but not yet bound. An attempt to invoke the accept method of an unbound server-socket channel will cause a NotYetBoundException to be thrown. A server-socket channel can be bound by invoking one of the bind methods defined by this class.

Socket options are configured using the setOption method. Server-socket channels support the following options:

Option Name Description
SO_RCVBUF The size of the socket receive buffer
SO_REUSEADDR Re-use address
Additional (implementation specific) options may also be supported.

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

Fields inherited from java.nio.channels.spi.AbstractSelectableChannel:
blocking
Constructor:
 protected ServerSocketChannel(SelectorProvider provider) 
    Initializes a new instance of this class.
Method from java.nio.channels.ServerSocketChannel Summary:
accept,   bind,   bind,   open,   setOption,   socket,   validOps
Methods from java.nio.channels.spi.AbstractSelectableChannel:
blockingLock,   configureBlocking,   implCloseChannel,   implCloseSelectableChannel,   implConfigureBlocking,   isBlocking,   isRegistered,   keyFor,   provider,   register,   removeKey
Methods from java.nio.channels.SelectableChannel:
blockingLock,   configureBlocking,   isBlocking,   isRegistered,   keyFor,   provider,   register,   register,   validOps
Methods from java.nio.channels.spi.AbstractInterruptibleChannel:
begin,   blockedOn,   close,   end,   implCloseChannel,   isOpen
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.nio.channels.ServerSocketChannel Detail:
 abstract public SocketChannel accept() throws IOException
    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 accept method of the 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 checkAccept method.

 public final ServerSocketChannel bind(SocketAddress local) throws IOException 
    Binds the channel's socket to a local address and configures the socket to listen for connections.

    An invocation of this method is equivalent to the following:

    bind(local, 0);
    
 abstract public ServerSocketChannel 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 an association between the socket and a local address. Once an association is established then the socket remains bound until the channel is closed.

    The {@code 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 altogther. If the {@code backlog} parameter has the value {@code 0}, or a negative value, then an implementation specific default is used.

 public static ServerSocketChannel open() throws IOException 
    Opens a server-socket channel.

    The new channel is created by invoking the openServerSocketChannel method of the system-wide default 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 bind methods before connections can be accepted.

 abstract public ServerSocketChannel setOption(SocketOption<T> name,
    T value) throws IOException
 abstract public ServerSocket 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.

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

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