| public class java.net ServerSocket
|
Java SE 6 |
The actual work of the server socket is performed by an instance
of the SocketImpl class. An application can
change the socket factory that creates the socket
implementation to configure itself to create sockets
appropriate to the local firewall.
| version | 1.90, 03/27/06 |
| since | JDK1.0 |
| See also | java.net.SocketImpl, setSocketFactory(java.net.SocketImplFactory), java.nio.channels.ServerSocketChannel |
| Constructors | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public | ServerSocket() throws IOException Details
Creates an unbound server socket.
| ||||||||||||||
| public | ServerSocket(int port) throws IOException Details
Creates a server socket, bound to the specified port. A port of
0 creates a socket on any free port.
The maximum queue length for incoming connection indications (a
request to connect) is set to
If the application has specified a server socket factory, that
factory's
If there is a security manager,
its
| ||||||||||||||
| public | ServerSocket(int port, int backlog) throws IOException Details
Creates a server socket and binds it to the specified local port
number, with the specified backlog.
A port number of 0 creates a socket on any
free port.
The maximum queue length for incoming connection indications (a
request to connect) is set to the
If the application has specified a server socket factory, that
factory's
If there is a security manager,
its The
| ||||||||||||||
| public | ServerSocket(int port, int backlog, InetAddress bindAddr) throws IOException Details
Create a server with the specified port, listen backlog, and
local IP address to bind to. The bindAddr argument
can be used on a multi-homed host for a ServerSocket that
will only accept connect requests to one of its addresses.
If bindAddr is null, it will default accepting
connections on any/all local addresses.
The port must be between 0 and 65535, inclusive.
If there is a security manager, this method
calls its The
| ||||||||||||||
| Methods | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public Socket | accept() throws IOException Details
Listens for a connection to be made to this socket and accepts
it. The method blocks until a connection is made.
A new Socket
| ||||||||||||||||
| public void | bind(SocketAddress endpoint) throws IOException Details
Binds the ServerSocket to a specific address
(IP address and port number).
If the address is
| ||||||||||||||||
| public void | bind(SocketAddress endpoint, int backlog) throws IOException Details
Binds the ServerSocket to a specific address
(IP address and port number).
If the address is
The
| ||||||||||||||||
| public void | close() throws IOException Details
Closes this socket.
Any thread currently blocked in #accept() will throw
a SocketException.
If this socket has an associated channel then the channel is closed as well.
| ||||||||||||||||
| final protected void | implAccept(Socket s) throws IOException Details
Subclasses of ServerSocket use this method to override accept()
to return their own subclass of socket. So a FooServerSocket
will typically hand this method an empty FooSocket. On
return from implAccept the FooSocket will be connected to a client.
| ||||||||||||||||
| public String | toString() Details
Returns the implementation address and implementation port of
this socket as a String.
| ||||||||||||||||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public boolean | isBound() Details
Returns the binding state of the ServerSocket.
| ||||||||||
| public ServerSocketChannel | getChannel() Details
Returns the unique java.nio.channels.ServerSocketChannel object
associated with this socket, if any.
A server socket will have a channel if, and only if, the channel
itself was created via the
| ||||||||||
| public boolean | isClosed() Details
Returns the closed state of the ServerSocket.
| ||||||||||
| public InetAddress | getInetAddress() Details
Returns the local address of this server socket.
| ||||||||||
| public int | getLocalPort() Details
Returns the port on which this socket is listening.
| ||||||||||
| public SocketAddress | getLocalSocketAddress() Details
Returns the address of the endpoint this socket is bound to, or
null if it is not bound yet.
| ||||||||||
| public void | setPerformancePreferences(int connectionTime, int latency, int bandwidth) Details
Sets performance preferences for this ServerSocket.
Sockets use the TCP/IP protocol by default. Some implementations may offer alternative protocols which have different performance characteristics than TCP/IP. This method allows the application to express its own preferences as to how these tradeoffs should be made when the implementation chooses from the available protocols. Performance preferences are described by three integers whose values indicate the relative importance of short connection time, low latency, and high bandwidth. The absolute values of the integers are irrelevant; in order to choose a protocol the values are simply compared, with larger values indicating stronger preferences. If the application prefers short connection time over both low latency and high bandwidth, for example, then it could invoke this method with the values (1, 0, 0). If the application prefers high bandwidth above low latency, and low latency above short connection time, then it could invoke this method with the values (0, 1, 2). Invoking this method after this socket has been bound will have no effect. This implies that in order to use this capability requires the socket to be created with the no-argument constructor.
| ||||||||||
| public void | setReceiveBufferSize(int size) throws SocketException Details
Sets a default proposed value for the SO_RCVBUF option for sockets
accepted from this ServerSocket. The value actually set
in the accepted socket must be determined by calling
Socket#getReceiveBufferSize() after the socket
is returned by #accept().
The value of SO_RCVBUF is used both to set the size of the internal socket receive buffer, and to set the size of the TCP receive window that is advertized to the remote peer.
It is possible to change the value subsequently, by calling
Failure to do this will not cause an error, and the buffer size may be set to the requested value but the TCP receive window in sockets accepted from this ServerSocket will be no larger than 64K bytes.
| ||||||||||
| public int | getReceiveBufferSize() throws SocketException Details
Gets the value of the SO_RCVBUF option for this ServerSocket,
that is the proposed buffer size that will be used for Sockets accepted
from this ServerSocket.
Note, the value actually set in the accepted socket is determined by
calling
| ||||||||||
| public void | setReuseAddress(boolean on) throws SocketException Details
Enable/disable the SO_REUSEADDR socket option.
When a TCP connection is closed the connection may remain in a timeout state for a period of time after the connection is closed (typically known as the TIME_WAIT state or 2MSL wait state). For applications using a well known socket address or port it may not be possible to bind a socket to the required SocketAddress if there is a connection in the timeout state involving the socket address or port.
Enabling SO_REUSEADDR prior to binding the socket
using
When a ServerSocket is created the initial setting
of SO_REUSEADDR is not defined. Applications can
use
The behaviour when SO_REUSEADDR is enabled or
disabled after a socket is bound (See
| ||||||||||
| public boolean | getReuseAddress() throws SocketException Details
Tests if SO_REUSEADDR is enabled.
| ||||||||||
| public static void | setSocketFactory(SocketImplFactory fac) throws IOException Details
Sets the server socket implementation factory for the
application. The factory can be specified only once.
When an application creates a new server socket, the socket
implementation factory's
Passing
If there is a security manager, this method first calls
the security manager's
| ||||||||||
| public void | setSoTimeout(int timeout) throws SocketException Details
Enable/disable SO_TIMEOUT with the specified timeout, in
milliseconds. With this option set to a non-zero timeout,
a call to accept() for this ServerSocket
will block for only this amount of time. If the timeout expires,
a java.net.SocketTimeoutException is raised, though the
ServerSocket is still valid. The option must be enabled
prior to entering the blocking operation to have effect. The
timeout must be > 0.
A timeout of zero is interpreted as an infinite timeout.
| ||||||||||
| public int | getSoTimeout() throws IOException Details
Retrieve setting for SO_TIMEOUT. 0 returns implies that the
option is disabled (i.e., timeout of infinity).
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|