This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.nio.channels
class ServerSocketChannel

java.lang.Object extended by java.nio.channels.spi.AbstractInterruptibleChannel extended by java.nio.channels.SelectableChannel extended by java.nio.channels.spi.AbstractSelectableChannel extended by java.nio.channels.ServerSocketChannel
All Implemented Interfaces:
Channel, InterruptibleChannel

Most common way to construct:

ServerSocketChannel ssc = ServerSocketChannel.open();

Based on 159 examples


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.


Constructor Summary
protected

          Initializes a new instance of this class.
 
Method Summary
abstract SocketChannel

          Accepts a connection made to this channel's socket.
static ServerSocketChannel

          Opens a server-socket channel.
abstract ServerSocket

          Retrieves a server socket associated with this channel.
 int

          Returns an operation set identifying this channel's supported operations.
 
Methods inherited from class java.nio.channels.spi.AbstractSelectableChannel
blockingLock, configureBlocking, implCloseChannel, implCloseSelectableChannel, implConfigureBlocking, isBlocking, isRegistered, keyFor, provider, register
 
Methods inherited from class java.nio.channels.SelectableChannel
blockingLock, configureBlocking, isBlocking, isRegistered, keyFor, provider, register, register, validOps
 
Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel
begin, close, end, implCloseChannel, isOpen
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerSocketChannel

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

Parameters:
provider
Method Detail

accept

public abstract 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 {@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.

Returns:
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:
IOException - If some other I/O error occurs

open

public static ServerSocketChannel open()
                                throws IOException
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.

Returns:
A new socket channel
Throws:
IOException - If an I/O error occurs

socket

public abstract 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 {@link java.net.ServerSocket} class.

Returns:
A server socket associated with this channel

validOps

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 {@link SelectionKey#OP_ACCEPT}.

Overrides:
validOps in class SelectableChannel
Returns:
The valid-operation set


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.