ServerSocketChannel
abstract class ServerSocketChannel : AbstractSelectableChannel, NetworkChannel
kotlin.Any | ||||
↳ | java.nio.channels.spi.AbstractInterruptibleChannel | |||
↳ | java.nio.channels.SelectableChannel | |||
↳ | java.nio.channels.spi.AbstractSelectableChannel | |||
↳ | java.nio.channels.ServerSocketChannel |
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 |
Server-socket channels are safe for use by multiple concurrent threads.
Summary
Protected constructors | |
---|---|
ServerSocketChannel(provider: SelectorProvider!) Initializes a new instance of this class. |
Public methods | |
---|---|
abstract SocketChannel! |
accept() Accepts a connection made to this channel's socket. |
ServerSocketChannel! |
bind(local: SocketAddress!) Binds the channel's socket to a local address and configures the socket to listen for connections. |
abstract ServerSocketChannel! |
bind(local: SocketAddress!, backlog: Int) Binds the channel's socket to a local address and configures the socket to listen for connections. |
abstract SocketAddress! |
Returns the socket address that this channel's socket is bound to. |
open static ServerSocketChannel! |
open() Opens a server-socket channel. |
abstract ServerSocketChannel! |
setOption(name: SocketOption<T>!, value: T) |
abstract ServerSocket! |
socket() Retrieves a server socket associated with this channel. |
Int |
validOps() Returns an operation set identifying this channel's supported operations. |
Inherited functions | |
---|---|
Protected constructors
ServerSocketChannel
protected ServerSocketChannel(provider: SelectorProvider!)
Initializes a new instance of this class.
Parameters | |
---|---|
provider |
SelectorProvider!: The provider that created this channel |
Public methods
accept
abstract fun accept(): SocketChannel!
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 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.
Return | |
---|---|
SocketChannel! |
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 |
Exceptions | |
---|---|
java.nio.channels.ClosedChannelException |
If this channel is closed |
java.nio.channels.AsynchronousCloseException |
If another thread closes this channel while the accept operation is in progress |
java.nio.channels.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 |
java.nio.channels.NotYetBoundException |
If this channel's socket has not yet been bound |
java.lang.SecurityException |
If a security manager has been installed and it does not permit access to the remote endpoint of the new connection |
java.io.IOException |
If some other I/O error occurs |
bind
fun bind(local: SocketAddress!): ServerSocketChannel!
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);
Parameters | |
---|---|
local |
SocketAddress!: The local address to bind the socket, or null to bind to an automatically assigned socket address |
Return | |
---|---|
ServerSocketChannel! |
This channel |
Exceptions | |
---|---|
java.nio.channels.AlreadyBoundException |
If the socket is already bound |
java.nio.channels.UnsupportedAddressTypeException |
If the type of the given address is not supported |
java.nio.channels.ClosedChannelException |
If the channel is closed |
java.io.IOException |
If some other I/O error occurs |
java.lang.SecurityException |
If a security manager has been installed and its checkListen method denies the operation |
bind
abstract fun bind(
local: SocketAddress!,
backlog: Int
): ServerSocketChannel!
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 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.
Parameters | |
---|---|
local |
SocketAddress!: The address to bind the socket, or null to bind to an automatically assigned socket address |
backlog |
Int: The maximum number of pending connections |
Return | |
---|---|
ServerSocketChannel! |
This channel |
Exceptions | |
---|---|
java.nio.channels.AlreadyBoundException |
If the socket is already bound |
java.nio.channels.UnsupportedAddressTypeException |
If the type of the given address is not supported |
java.nio.channels.ClosedChannelException |
If this channel is closed |
java.io.IOException |
If some other I/O error occurs |
java.lang.SecurityException |
If a security manager has been installed and its checkListen method denies the operation |
getLocalAddress
abstract fun getLocalAddress(): SocketAddress!
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 .
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.
Return | |
---|---|
SocketAddress! |
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 |
Exceptions | |
---|---|
java.nio.channels.ClosedChannelException |
If the channel is closed |
java.io.IOException |
If an I/O error occurs |
open
open static fun open(): ServerSocketChannel!
Opens a server-socket channel.
The new channel is created by invoking the openServerSocketChannel
method of the system-wide default 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.
Return | |
---|---|
ServerSocketChannel! |
A new socket channel |
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
setOption
abstract fun <T : Any!> setOption(
name: SocketOption<T>!,
value: T
): ServerSocketChannel!
Parameters | |
---|---|
<T> |
The type of the socket option value |
name |
SocketOption<T>!: The socket option |
value |
T: The value of the socket option. A value of null may be a valid value for some socket options. |
Return | |
---|---|
ServerSocketChannel! |
This channel |
Exceptions | |
---|---|
java.lang.UnsupportedOperationException |
If the socket option is not supported by this channel |
java.lang.IllegalArgumentException |
If the value is not a valid value for this socket option |
java.nio.channels.ClosedChannelException |
If this channel is closed |
java.io.IOException |
If an I/O error occurs |
socket
abstract fun socket(): ServerSocket!
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.
Return | |
---|---|
ServerSocket! |
A server socket associated with this channel |
validOps
fun validOps(): Int
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
.
Return | |
---|---|
Int |
The valid-operation set |