java::net::ServerSocket Class Reference

Inheritance diagram for java::net::ServerSocket:

Inheritance graph
java::lang::Object
[legend]
Collaboration diagram for java::net::ServerSocket:

Collaboration graph
java::lang::Object
[legend]

List of all members.


Detailed Description

This class implements server sockets.

A server socket waits for requests to come in over the network. It performs some operation based on that request, and then possibly returns a result to the requester.

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.

Author:
unascribed
Version:
1.75, 01/23/03
See also:
java.net.SocketImpl

java.net.ServerSocket::setSocketFactory(java.net.SocketImplFactory)

java.nio.channels.ServerSocketChannel

Since:
JDK1.0

Public Member Functions

 ServerSocket ()
 Creates an unbound server socket.
 ServerSocket (jint port, jint backlog=50, const Ref< InetAddress > &bindAddress=0)
 Create a server with the specified port, listen backlog, and local IP address to bind to.
virtual jboolean isBound () const
 Returns the binding state of the ServerSocket.
virtual jboolean isClosed () const
 Returns the closed state of the ServerSocket.
virtual void bind (const Ref< SocketAddress > &endpoint, jint backlog=50)
 Binds the ServerSocket to a specific address (IP address and port number).
virtual Ref
< InetAddress
getInetAddress () const
 Returns the local address of this server socket.
virtual jint getLocalPort () const
 Returns the port on which this socket is listening.
virtual Ref
< SocketAddress
getLocalSocketAddress () const
 Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
virtual Ref< Socketaccept ()
 Listens for a connection to be made to this socket and accepts it.
virtual void close ()
 Closes this socket.
virtual void setSoTimeout (jint timeout)
 Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
virtual jint getSoTimeout () const
 Retrive setting for SO_TIMEOUT.
virtual void setReuseAddress (jboolean on)
 Enable/disable the SO_REUSEADDR socket option.
virtual jboolean getReuseAddress () const
 Tests if SO_REUSEADDR is enabled.
virtual void setReceiveBufferSize (jint size)
 Sets a default proposed value for the SO_RCVBUF option for sockets accepted from this ServerSocket.
virtual jint getReceiveBufferSize () const
 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.
virtual String toString () const
 Returns the implementation address and implementation port of this socket as a String.

Static Public Member Functions

static void setSocketImplFactory (const Ref< SocketImplFactory > &fac)
 Sets the server socket implementation factory for the application.

Protected Member Functions

virtual void setImpl ()
 Sets impl to the system-default type of SocketImpl.

Constructor & Destructor Documentation

java::net::ServerSocket::ServerSocket (  ) 

Creates an unbound server socket.

Exceptions:
IOException IO error when opening the socket. 1.4

java::net::ServerSocket::ServerSocket ( jint  port,
jint  backlog = 50,
const Ref< InetAddress > &  bindAddress = 0 
)

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 checkListen method with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.

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.

Parameters:
port the local TCP port
backlog the listen backlog
bindAddr the local InetAddress the server will bind to
Exceptions:
SecurityException if a security manager exists and its checkListen method doesn't allow the operation.
IOException if an I/O error occurs when opening the socket.
See also:
SocketOptions

SocketImpl

SecurityManager::checkListen

Since:
JDK1.1


Member Function Documentation

static void java::net::ServerSocket::setSocketImplFactory ( const Ref< SocketImplFactory > &  fac  )  [static]

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 createSocketImpl method is called to create the actual socket implementation.

If there is a security manager, this method first calls the security manager's checkSetFactory method to ensure the operation is allowed. This could result in a SecurityException.

Parameters:
fac the desired factory.
Exceptions:
IOException if an I/O error occurs when setting the socket factory.
SocketException if the factory has already been defined.
SecurityException if a security manager exists and its checkSetFactory method doesn't allow the operation.
See also:
java.net.SocketImplFactory::createSocketImpl()

SecurityManager::checkSetFactory

virtual jboolean java::net::ServerSocket::isBound (  )  const [virtual]

Returns the binding state of the ServerSocket.

Returns:
true if the ServerSocket succesfuly bound to an address
Since:
1.4

virtual jboolean java::net::ServerSocket::isClosed (  )  const [virtual]

Returns the closed state of the ServerSocket.

Returns:
true if the socket has been closed
Since:
1.4

virtual void java::net::ServerSocket::bind ( const Ref< SocketAddress > &  endpoint,
jint  backlog = 50 
) [virtual]

Binds the ServerSocket to a specific address (IP address and port number).

If the address is null, then the system will pick up an ephemeral port and a valid local address to bind the socket.

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.

Parameters:
endpoint The IP address & port number to bind to.
backlog The listen backlog length.
Exceptions:
IOException if the bind operation fails, or if the socket is already bound.
SecurityException if a SecurityManager is present and its checkListen method doesn't allow the operation.
IllegalArgumentException if endpoint is a SocketAddress subclass not supported by this socket
Since:
1.4

virtual Ref<InetAddress> java::net::ServerSocket::getInetAddress (  )  const [virtual]

Returns the local address of this server socket.

Returns:
the address to which this socket is bound, or null if the socket is unbound.

virtual jint java::net::ServerSocket::getLocalPort (  )  const [virtual]

Returns the port on which this socket is listening.

Returns:
the port number to which this socket is listening or -1 if the socket is not bound yet.

virtual Ref<SocketAddress> java::net::ServerSocket::getLocalSocketAddress (  )  const [virtual]

Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.

Returns:
a SocketAddress representing the local endpoint of this socket, or null if it is not bound yet.
See also:
getInetAddress()

getLocalPort()

bind(SocketAddress)

Since:
1.4

virtual Ref<Socket> java::net::ServerSocket::accept (  )  [virtual]

Listens for a connection to be made to this socket and accepts it.

The method blocks until a connection is made.

A new Socket s is created and, if there is a security manager, the security manager's checkAccept method is called with s.getInetAddress().getHostAddress() and s.getPort() as its arguments to ensure the operation is allowed. This could result in a SecurityException.

Exceptions:
IOException if an I/O error occurs when waiting for a connection.
SecurityException if a security manager exists and its checkListen method doesn't allow the operation.
SocketTimeoutException if a timeout was previously set with setSoTimeout and the timeout has been reached.
java.nio.channels.IllegalBlockingModeException if this socket has an associated channel, and the channel is in non-blocking mode.
Returns:
the new Socket
See also:
SecurityManager::checkAccept 1.4 JSR-51

virtual void java::net::ServerSocket::close (  )  [virtual]

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.

Exceptions:
IOException if an I/O error occurs when closing the socket. 1.4 JSR-51

virtual void java::net::ServerSocket::setSoTimeout ( jint  timeout  )  [virtual]

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.

Parameters:
timeout the specified timeout, in milliseconds
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1
See also:
getSoTimeout()

virtual jint java::net::ServerSocket::getSoTimeout (  )  const [virtual]

Retrive setting for SO_TIMEOUT.

0 returns implies that the option is disabled (i.e., timeout of infinity).

Returns:
the SO_TIMEOUT value
Exceptions:
IOException if an I/O error occurs
Since:
JDK1.1
See also:
setSoTimeout(int)

virtual void java::net::ServerSocket::setReuseAddress ( jboolean  on  )  [virtual]

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 bind(SocketAddress) allows the socket to be bound even though a previous connection is in a timeout state.

When a ServerSocket is created the initial setting of SO_REUSEADDR is not defined. Applications can use getReuseAddress() to determine the initial setting of SO_REUSEADDR.

The behaviour when SO_REUSEADDR is enabled or disabled after a socket is bound (See isBound()) is not defined.

Parameters:
on whether to enable or disable the socket option
Exceptions:
SocketException if an error occurs enabling or disabling the SO_RESUEADDR socket option, or the socket is closed.
Since:
1.4
See also:
getReuseAddress()

bind(SocketAddress)

isBound()

isClosed()

virtual jboolean java::net::ServerSocket::getReuseAddress (  )  const [virtual]

Tests if SO_REUSEADDR is enabled.

Returns:
a boolean indicating whether or not SO_REUSEADDR is enabled.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
1.4
See also:
setReuseAddress(boolean)

virtual void java::net::ServerSocket::setReceiveBufferSize ( jint  size  )  [virtual]

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 Socket#setReceiveBufferSize(int). However, if the application wishes to allow a receive window larger than 64K bytes, as defined by RFC1323 then the proposed value must be set in the ServerSocket before it is bound to a local address. This implies, that the ServerSocket must be created with the no-argument constructor, then setReceiveBufferSize() must be called and lastly the ServerSocket is bound to an address by calling bind().

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.

Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Parameters:
size the size to which to set the receive buffer size. This value must be greater than 0.
Exceptions:
IllegalArgumentException if the value is 0 or is negative.
Since:
1.4
See also:
getReceiveBufferSize

virtual jint java::net::ServerSocket::getReceiveBufferSize (  )  const [virtual]

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 Socket#getReceiveBufferSize().

Returns:
the value of the SO_RCVBUF option for this Socket.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
See also:
setReceiveBufferSize(int)
Since:
1.4

virtual String java::net::ServerSocket::toString (  )  const [virtual]

Returns the implementation address and implementation port of this socket as a String.

Returns:
a string representation of this socket.

Reimplemented from java::lang::Object.

virtual void java::net::ServerSocket::setImpl (  )  [protected, virtual]

Sets impl to the system-default type of SocketImpl.

Since:
1.4


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:44 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3