AsynchronousServerSocketChannel

java.lang.Object
- java.nio.channels.AsynchronousServerSocketChannel

所有已实现的接口:

Closeable, AutoCloseable, AsynchronousChannel, Channel, NetworkChannel
```
public abstract class AsynchronousServerSocketChannel
extends Object
implements AsynchronousChannel, NetworkChannel
```
An asynchronous channel for stream-oriented listening sockets.
An asynchronous server-socket channel is created by invoking the open method of this class. A newly-created asynchronous server-socket channel is open but not yet bound. It can be bound to a local address and configured to listen for connections by invoking the bind method. Once bound, the accept method is used to initiate the accepting of connections to the channel's socket. An attempt to invoke the accept method on an unbound channel will cause a NotYetBoundException to be thrown.
Channels of this type are safe for use by multiple concurrent threads though at most one accept operation can be outstanding at any time. If a thread initiates an accept operation before a previous accept operation has completed then an AcceptPendingException will be thrown.
Socket options are configured using the setOption method. Channels of this type 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.
Usage Example:
```
  final AsynchronousServerSocketChannel listener =
      AsynchronousServerSocketChannel.open().bind(new InetSocketAddress(5000));

  listener.accept(null, new CompletionHandler<AsynchronousSocketChannel,Void>() {
      public void completed(AsynchronousSocketChannel ch, Void att) {
          // accept the next connection
          listener.accept(null, this);

          // handle this connection
          handle(ch);
      }
      public void failed(Throwable exc, Void att) {
          ...
      }
  });
 
```
从以下版本开始:

1.7

Option Name	Description
`SO_RCVBUF`	The size of the socket receive buffer
`SO_REUSEADDR`	Re-use address

构造器概要

构造器
限定符构造器说明

protected AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)
Initializes a new instance of this class.

构造器
限定符	构造器	说明
`protected`	`AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)`	Initializes a new instance of this class.

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`abstract Future<AsynchronousSocketChannel>`	`accept()`	Accepts a connection.
`abstract <A> void`	`accept(A attachment, CompletionHandler<AsynchronousSocketChannel,? super A> handler)`	Accepts a connection.
`AsynchronousServerSocketChannel`	`bind(SocketAddress local)`	Binds the channel's socket to a local address and configures the socket to listen for connections.
`abstract AsynchronousServerSocketChannel`	`bind(SocketAddress local, int backlog)`	Binds the channel's socket to a local address and configures the socket to listen for connections.
`abstract SocketAddress`	`getLocalAddress()`	Returns the socket address that this channel's socket is bound to.
`static AsynchronousServerSocketChannel`	`open()`	Opens an asynchronous server-socket channel.
`static AsynchronousServerSocketChannel`	`open(AsynchronousChannelGroup group)`	Opens an asynchronous server-socket channel.
`AsynchronousChannelProvider`	`provider()`	Returns the provider that created this channel.
`abstract <T> AsynchronousServerSocketChannel`	`setOption(SocketOption<T> name, T value)`	Sets the value of a socket option.

从接口继承的方法 java.nio.channels.AsynchronousChannel
close

从接口继承的方法 java.nio.channels.Channel
isOpen

从接口继承的方法 java.nio.channels.NetworkChannel
getOption, supportedOptions

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AsynchronousServerSocketChannel
```
protected AsynchronousServerSocketChannel(AsynchronousChannelProvider provider)
```
    Initializes a new instance of this class.
    
    参数:
    
    provider - The provider that created this channel
- 方法详细资料
  - provider
```
public final AsynchronousChannelProvider provider()
```
    Returns the provider that created this channel.
    
    返回:
    
    The provider that created this channel
  - open
```
public static AsynchronousServerSocketChannel open(AsynchronousChannelGroup group)
                                            throws IOException
```
    Opens an asynchronous server-socket channel.
    The new channel is created by invoking the openAsynchronousServerSocketChannel method on the AsynchronousChannelProvider object that created the given group. If the group parameter is null then the resulting channel is created by the system-wide default provider, and bound to the default group.
    
    参数:
    
    group - The group to which the newly constructed channel should be bound, or null for the default group
    
    返回:
    
    A new asynchronous server socket channel
    
    抛出:
    
    ShutdownChannelGroupException - If the channel group is shutdown
    
    IOException - If an I/O error occurs
  - open
```
public static AsynchronousServerSocketChannel open()
                                            throws IOException
```
    Opens an asynchronous server-socket channel.
    This method returns an asynchronous server socket channel that is bound to the default group. This method is equivalent to evaluating the expression:
    open((AsynchronousChannelGroup)null);
    返回:
    
    A new asynchronous server socket channel
    
    抛出:
    
    IOException - If an I/O error occurs
  - bind
```
public final AsynchronousServerSocketChannel 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);
    指定者:
    
    bind 在接口中 NetworkChannel
    
    参数:
    
    local - The local address to bind the socket, or null to bind to an automatically assigned socket address
    
    返回:
    
    This channel
    
    抛出:
    
    AlreadyBoundException - If the socket is already bound
    
    UnsupportedAddressTypeException - If the type of the given address is not supported
    
    SecurityException - If a security manager is installed and it denies an unspecified permission. An implementation of this interface should specify any required permissions.
    
    ClosedChannelException - If the channel is closed
    
    IOException - If some other I/O error occurs
    
    另请参阅:
    
    NetworkChannel.getLocalAddress()
  - bind
```
public abstract AsynchronousServerSocketChannel 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 associated 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 altogther. 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 to an automatically assigned socket address
    
    backlog - The maximum number of pending connections
    
    返回:
    
    This channel
    
    抛出:
    
    AlreadyBoundException - If the socket is already bound
    
    UnsupportedAddressTypeException - If the type of the given address is not supported
    
    SecurityException - If a security manager has been installed and its SecurityManager#checkListen method denies the operation
    
    ClosedChannelException - If the channel is closed
    
    IOException - If some other I/O error occurs
  - setOption
```
public abstract <T> AsynchronousServerSocketChannel setOption(SocketOption<T> name,
                                                              T value)
                                                       throws IOException
```
    从接口复制的说明: NetworkChannel
    
    Sets the value of a socket option.
    
    指定者:
    
    setOption 在接口中 NetworkChannel
    
    类型参数:
    
    T - The type of the socket option value
    
    参数:
    
    name - The socket option
    
    value - The value of the socket option. A value of null may be a valid value for some socket options.
    
    返回:
    
    This channel
    
    抛出:
    
    IllegalArgumentException - If the value is not a valid value for this socket option
    
    ClosedChannelException - If this channel is closed
    
    IOException - If an I/O error occurs
    
    另请参阅:
    
    StandardSocketOptions
  - accept
```
public abstract <A> void accept(A attachment,
                                CompletionHandler<AsynchronousSocketChannel,? super A> handler)
```
    Accepts a connection.
    This method initiates an asynchronous operation to accept a connection made to this channel's socket. The handler parameter is a completion handler that is invoked when a connection is accepted (or the operation fails). The result passed to the completion handler is the AsynchronousSocketChannel to the new connection.
    When a new connection is accepted then the resulting AsynchronousSocketChannel will be bound to the same AsynchronousChannelGroup as this channel. If the group is AsynchronousChannelGroup#isShutdown and a connection is accepted, then the connection is closed, and the operation completes with an IOException and cause ShutdownChannelGroupException.
    To allow for concurrent handling of new connections, the completion handler is not invoked directly by the initiating thread when a new connection is accepted immediately (see Threading).
    If a security manager has been installed then it verifies that the address and port number of the connection's remote endpoint are permitted by the security manager's SecurityManager#checkAccept method. The permission check is performed with privileges that are restricted by the calling context of this method. If the permission check fails then the connection is closed and the operation completes with a SecurityException.
    
    类型参数:
    
    A - The type of the attachment
    
    参数:
    
    attachment - The object to attach to the I/O operation; can be null
    
    handler - The handler for consuming the result
    
    抛出:
    
    AcceptPendingException - If an accept operation is already in progress on this channel
    
    NotYetBoundException - If this channel's socket has not yet been bound
    
    ShutdownChannelGroupException - If the channel group has terminated
  - accept
```
public abstract Future<AsynchronousSocketChannel> accept()
```
    Accepts a connection.
    This method initiates an asynchronous operation to accept a connection made to this channel's socket. The method behaves in exactly the same manner as the accept(java.lang.Object,java.nio.channels.CompletionHandler) method except that instead of specifying a completion handler, this method returns a Future representing the pending result. The Future's Future#get() method returns the AsynchronousSocketChannel to the new connection on successful completion.
    
    返回:
    
    a Future object representing the pending result
    
    抛出:
    
    AcceptPendingException - If an accept operation is already in progress on this channel
    
    NotYetBoundException - If this channel's socket has not yet been bound
  - getLocalAddress
```
public abstract SocketAddress getLocalAddress()
                                       throws IOException
```
    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 InetSocketAddress.
    If there is a security manager set, its checkConnect method is called with the local address and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, a SocketAddress representing the loopback address and the local port of the channel's socket is returned.
    
    指定者:
    
    getLocalAddress 在接口中 NetworkChannel
    
    返回:
    
    The SocketAddress that the socket is bound to, or the SocketAddress representing the loopback address if denied by the security manager, or null if the channel's socket is not bound
    
    抛出:
    
    ClosedChannelException - If the channel is closed
    
    IOException - If an I/O error occurs

类 AsynchronousServerSocketChannel

构造器概要

方法概要

从接口继承的方法 java.nio.channels.AsynchronousChannel

从接口继承的方法 java.nio.channels.Channel

从接口继承的方法 java.nio.channels.NetworkChannel

从类继承的方法 java.lang.Object

构造器详细资料

AsynchronousServerSocketChannel

方法详细资料

provider

open

open

bind

bind

setOption

accept

accept

getLocalAddress