ServerSocketFactory
abstract class ServerSocketFactory
| kotlin.Any | |
| ↳ | javax.net.ServerSocketFactory |
This class creates server sockets. It may be subclassed by other factories, which create particular types of server sockets. This provides a general framework for the addition of public socket-level functionality. It is the server side analogue of a socket factory, and similarly provides a way to capture a variety of policies related to the sockets being constructed.
Like socket factories, server Socket factory instances have methods used to create sockets. There is also an environment specific default server socket factory; frameworks will often use their own customized factory.
Summary
| Protected constructors | |
|---|---|
|
Creates a server socket factory. |
|
| Public methods | |
|---|---|
| open ServerSocket! |
Returns an unbound server socket. |
| abstract ServerSocket! |
createServerSocket(port: Int)Returns a server socket bound to the specified port. |
| abstract ServerSocket! |
createServerSocket(port: Int, backlog: Int)Returns a server socket bound to the specified port, and uses the specified connection backlog. |
| abstract ServerSocket! |
createServerSocket(port: Int, backlog: Int, ifAddress: InetAddress!)Returns a server socket bound to the specified port, with a specified listen backlog and local IP. |
| open static ServerSocketFactory! |
Returns a copy of the environment's default socket factory. |
Protected constructors
ServerSocketFactory
protected ServerSocketFactory()
Creates a server socket factory.
Public methods
createServerSocket
open fun createServerSocket(): ServerSocket!
Returns an unbound server socket. The socket is configured with the socket options (such as accept timeout) given to this factory.
| Return | |
|---|---|
ServerSocket! |
the unbound socket |
| Exceptions | |
|---|---|
java.io.IOException |
if the socket cannot be created |
createServerSocket
abstract fun createServerSocket(port: Int): ServerSocket!
Returns a server socket bound to the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.
If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.
| Parameters | |
|---|---|
port |
Int: the port to listen to |
| Return | |
|---|---|
ServerSocket! |
the ServerSocket |
| Exceptions | |
|---|---|
java.io.IOException |
for networking errors |
java.lang.SecurityException |
if a security manager exists and its checkListen method doesn't allow the operation. |
java.lang.IllegalArgumentException |
if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. |
createServerSocket
abstract fun createServerSocket(
port: Int,
backlog: Int
): ServerSocket!
Returns a server socket bound to the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.
The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.
If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.
| Parameters | |
|---|---|
port |
Int: the port to listen to |
backlog |
Int: how many connections are queued |
| Return | |
|---|---|
ServerSocket! |
the ServerSocket |
| Exceptions | |
|---|---|
java.io.IOException |
for networking errors |
java.lang.SecurityException |
if a security manager exists and its checkListen method doesn't allow the operation. |
java.lang.IllegalArgumentException |
if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. |
createServerSocket
abstract fun createServerSocket(
port: Int,
backlog: Int,
ifAddress: InetAddress!
): ServerSocket!
Returns a server socket bound to the specified port, with a specified listen backlog and local IP.
The ifAddress argument can be used on a multi-homed host for a ServerSocket that will only accept connect requests to one of its addresses. If ifAddress is null, it will accept connections on all local addresses. The socket is configured with the socket options (such as accept timeout) given to this factory.
The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.
If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.
| Parameters | |
|---|---|
port |
Int: the port to listen to |
backlog |
Int: how many connections are queued |
ifAddress |
InetAddress!: the network interface address to use |
| Return | |
|---|---|
ServerSocket! |
the ServerSocket |
| Exceptions | |
|---|---|
java.io.IOException |
for networking errors |
java.lang.SecurityException |
if a security manager exists and its checkListen method doesn't allow the operation. |
java.lang.IllegalArgumentException |
if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive. |
getDefault
open static fun getDefault(): ServerSocketFactory!
Returns a copy of the environment's default socket factory.
| Return | |
|---|---|
ServerSocketFactory! |
the ServerSocketFactory |