TopBlend: Here is the first difference. There are 262 differences. is old. is new.

java.net
Class ServerSocket


java.lang.Object
  extended by java.net.ServerSocket
Direct Known Subclasses:
SSLServerSocket 
public class ServerSocket
extends Object

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.

Since:
JDK1.0
See Also:
SocketImpl , setSocketFactory(java.net.SocketImplFactory) , ServerSocketChannel

Constructor Summary
ServerSocket ()
          Creates an unbound server socket.
ServerSocket (int port)
          Creates a server socket, bound to the specified port.
ServerSocket (int port, int backlog)
          Creates a server socket and binds it to the specified local port number, with the specified backlog.
ServerSocket (int port, int backlog, InetAddress  bindAddr)
          Create a server with the specified port, listen backlog, and local IP address to bind to.
ServerSocket ( Proxy
          Creates an unbound server socket, specifying the type of proxy, if any, that should be used regardless of any other settings.
 
Method Summary
  Socket accept ()
          Listens for a connection to be made to this socket and accepts it.
 void bind ( SocketAddress  endpoint)
          Binds the ServerSocket to a specific address (IP address and port number).
 void bind ( SocketAddress  endpoint, int backlog)
          Binds the ServerSocket to a specific address (IP address and port number).
 void close ()
          Closes this socket.
  ServerSocketChannel getChannel ()
          Returns the unique ServerSocketChannel object associated with this socket, if any.
  InetAddress getInetAddress ()
          Returns the local address of this server socket.
 int getLocalPort ()
          Returns the port on which this socket is listening.
  SocketAddress getLocalSocketAddress ()
          Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
 int getReceiveBufferSize ()
          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 .
 boolean getReuseAddress ()
          Tests if SO_REUSEADDR is enabled.
 int getSoTimeout ()
          Retrive setting for SO_TIMEOUT.
protected  void implAccept ( Socket  s)
          Subclasses of ServerSocket use this method to override accept() to return their own subclass of socket.
 boolean isBound ()
          Returns the binding state of the ServerSocket.
 boolean isClosed ()
          Returns the closed state of the ServerSocket.
 void setPerformancePreferences (int connectionTime, int latency, int bandwidth)
          Sets performance preferences for this ServerSocket.
 void setReceiveBufferSize (int size)
          Sets a default proposed value for the SO_RCVBUF option for sockets accepted from this ServerSocket .
 void setReuseAddress (boolean on)
          Enable/disable the SO_REUSEADDR socket option.
static void setSocketFactory ( SocketImplFactory  fac)
          Sets the server socket implementation factory for the application.
 void setSoTimeout (int timeout)
          Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
  String toString ()
          Returns the implementation address and implementation port of this socket as a String.
 
Methods inherited from class java.lang. Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , wait , wait , wait
 

Constructor Detail

ServerSocket


public ServerSocket()
             throws IOException
Creates an unbound server socket.

Throws:
IOException - IO error when opening the socket.

ServerSocket


public ServerSocket(int port)
 throws IOException( Proxy proxy)
Creates a server socket, bound to the specified port. A port of 0 creates a socket on any free port. Creates an unbound server socket, specifying the type of proxy, if any, that should be used regardless of any other settings.

The maximum queue length for incoming connection indications (a request to connect) is set to 50. If a connection indication arrives when the queue is full, the connection is refused. If there is a security manager, its checkConnect method is called with the proxy host address and port number as its arguments. This could result in a SecurityException.

If the application has specified a server socket factory, that factory's createSocketImpl method is called to create the actual socket implementation. Otherwise a "plain" socket is created. Examples:

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 - the port number, or 0 to use any free port. proxy - a Proxy object specifying what kind of proxying should be used.
Throws:
IOException IllegalArgumentException - if an I/O error occurs when opening the socket. - if the proxy is of an invalid type or is null.
SecurityException - if a security manager exists and its checkListen method doesn't allow the operation. - if a security manager is present and permission to connect to the proxy is denied.
Since:
1.5
See Also:
SocketImpl ProxySelector , SocketImplFactory.createSocketImpl() Proxy , setSocketFactory(java.net.SocketImplFactory) , SecurityManager.checkListen(int)

ServerSocket


public ServerSocket(int port,
 int backlog)
 (int port)
 throws IOException
Creates a server socket and binds it socket, bound to the specified local port number, with the specified backlog. port. 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 backlog parameter. 50. If a connection indication arrives when the queue is full, the connection is refused.

If the application has specified a server socket factory, that factory's createSocketImpl method is called to create the actual socket implementation. Otherwise a "plain" socket is created.

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.

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 specified port, port number, or 0 to use any free port.
backlog - the maximum length of the queue.
Throws:
IOException - if an I/O error occurs when opening the socket.
SecurityException - if a security manager exists and its checkListen method doesn't allow the operation.
See Also:
SocketImpl , SocketImplFactory.createSocketImpl() , setSocketFactory(java.net.SocketImplFactory) , SecurityManager.checkListen(int)

ServerSocket


public ServerSocket(int port,
 int backlog,
 InetAddress(int port,
 int backlog)
 throws IOException bindAddr)
 throws IOException
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. 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.

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. The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full, the connection is refused.

If the application has specified a server socket factory, that factory's createSocketImpl method is called to create the actual socket implementation. Otherwise a "plain" socket is created.

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.

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 port - the specified port, or 0 to use any free port.
backlog - the listen backlog
bindAddr - the local InetAddress the server will bind to backlog - the maximum length of the queue.
Throws:
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.
Since:
JDK1.1
SecurityException - if a security manager exists and its checkListen method doesn't allow the operation.
See Also:
SocketOptions SocketImpl , SocketImpl SocketImplFactory.createSocketImpl() , setSocketFactory(java.net.SocketImplFactory) , SecurityManager.checkListen(int)
Method Detail

bind ServerSocket 


public void bind ServerSocket ( SocketAddress(int port,
 int backlog,
 InetAddress endpoint)
  bindAddr)
 throws IOException
Binds the ServerSocket to a specific address (IP address and port number). 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 the address is null, then the system will pick up an ephemeral port and a valid local address to bind the socket. 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:
endpoint - The IP address & port number to bind to. port - the local TCP port
backlog - the listen backlog
bindAddr - the local InetAddress the server will bind to
Throws:
IOException - if the bind operation fails, or if the socket is already bound.
SecurityException - if a SecurityManager is present security manager exists and its checkListen method doesn't allow the operation.
IllegalArgumentException IOException - if endpoint is a SocketAddress subclass not supported by this socket - if an I/O error occurs when opening the socket.
Since:
1.4 JDK1.1
See Also:
SocketOptions , SocketImpl , SecurityManager.checkListen(int)
Method Detail

bind


public void bind(SocketAddress endpoint,
 int backlog)
  endpoint)
 throws IOException
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.
Throws:
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

getInetAddress bind 


public InetAddress
public void getInetAddress bind () ( SocketAddress endpoint,
 int backlog)
 throws IOException
Returns the local address of this server socket. 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.

Returns: Parameters:
the address to which this socket is bound, or null if the socket is unbound. endpoint - The IP address & port number to bind to.
backlog - The listen backlog length.
Throws:
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

getLocalPort getInetAddress 


public int 
public InetAddressgetLocalPort getInetAddress ()
Returns the port on which this socket is listening. Returns the local address of this server socket.

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

getLocalSocketAddress getLocalPort 


public SocketAddress
public int getLocalSocketAddress getLocalPort ()
Returns the address of the endpoint this socket is bound to, or null if it is not bound yet. Returns the port on which this socket is listening.

Returns:
a SocketAddress representing the local endpoint of this socket, or null if it is not bound yet.
Since:
1.4
See Also:
getInetAddress() , getLocalPort() , bind(SocketAddress) the port number to which this socket is listening or -1 if the socket is not bound yet.

accept getLocalSocketAddress 


public SocketSocketAddressaccept getLocalSocketAddress ()
 throws IOException()
Listens for a connection to be made to this socket and accepts it. The method blocks until a connection is made. Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.

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.

Returns:
the new Socket a SocketAddress representing the local endpoint of this socket, or null if it is not bound yet.
Throws: Since:
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.
IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode. 1.4
See Also:
SecurityManager.checkAccept(java.lang.String, int) getInetAddress() , getLocalPort() , bind(SocketAddress)

implAccept accept 


protected final void 
public SocketimplAccept accept ( Socket()
 throws IOException s)
 throws IOException
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. 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.

Parameters: Returns:
s - the new Socket
Throws:
IllegalBlockingModeException IOException - if this socket has an associated channel, and the channel is in non-blocking mode - if an I/O error occurs when waiting for a connection.
IOException SecurityException - if an I/O error occurs when waiting for a connection. - 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.
IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode.
Since: See Also:
JDK1.1
SecurityManager.checkAccept(java.lang.String, int)

close implAccept 


public void 
protected final void close implAccept ()
 throws IOException( Socket s)
 throws IOException
Closes this socket. Any thread currently blocked in accept() will throw a SocketException . 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.

If this socket has an associated channel then the channel is closed as well.

Parameters:
s - the Socket
Throws:
IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode
IOException - if an I/O error occurs when closing the socket. - if an I/O error occurs when waiting for a connection.
Since:
JDK1.1

getChannel close 


public ServerSocketChannel
public void getChannel close () ()
 throws IOException
Returns the unique ServerSocketChannel Closes this socket. Any thread currently blocked in accept() object associated with this socket, if any. will throw a SocketException .

A server socket will have a channel if, and only if, the channel itself was created via the ServerSocketChannel.open method. If this socket has an associated channel then the channel is closed as well.

Returns: Throws:
the server-socket channel associated with this socket, or null if this socket was not created for a channel
Since:
1.4
IOException - if an I/O error occurs when closing the socket.

isBound getChannel 


public boolean 
public ServerSocketChannelisBound getChannel ()
Returns the binding state of the ServerSocket. Returns the unique 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 ServerSocketChannel.open method.

Returns:
true if the ServerSocket succesfuly bound to an address the server-socket channel associated with this socket, or null if this socket was not created for a channel
Since:
1.4

isClosed isBound 


public boolean isClosed isBound ()
Returns the closed binding state of the ServerSocket.

Returns:
true if the socket has been closed true if the ServerSocket succesfuly bound to an address
Since:
1.4

setSoTimeout isClosed 


public void boolean setSoTimeout isClosed (int timeout)
 throws SocketException()
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. Returns the closed state of the ServerSocket.

Parameters: Returns:
timeout - the specified timeout, in milliseconds true if the socket has been closed
Throws:
SocketException - if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1 1.4
See Also:
getSoTimeout()

getSoTimeout setSoTimeout 


public int void getSoTimeout setSoTimeout ()
 throws IOException(int timeout)
 throws SocketException
Retrive setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity). 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.

Returns: Parameters:
the SO_TIMEOUT value timeout - the specified timeout, in milliseconds
Throws:
IOException SocketException - if an I/O error occurs - if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1
See Also:
setSoTimeout(int) getSoTimeout()

setReuseAddress getSoTimeout 


public void int setReuseAddress getSoTimeout (boolean on)
 throws SocketException()
 throws IOException
Enable/disable the SO_REUSEADDR socket option. Retrive setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).

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: Returns:
on - whether to enable or disable the socket option the SO_TIMEOUT value
Throws:
SocketException IOException - if an error occurs enabling or disabling the SO_RESUEADDR socket option, or the socket is closed. - if an I/O error occurs
Since:
1.4 JDK1.1
See Also:
getReuseAddress() setSoTimeout(int) , bind(SocketAddress) , isBound() , isClosed()

getReuseAddress setReuseAddress 


public boolean void getReuseAddress setReuseAddress ()
 (boolean on)
 throws SocketException
Tests if SO_REUSEADDR is enabled. 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.

Returns: Parameters:
a boolean indicating whether or not SO_REUSEADDR is enabled. on - whether to enable or disable the socket option
Throws:
SocketException - if there is an error in the underlying protocol, such as a TCP error. - if an error occurs enabling or disabling the SO_RESUEADDR socket option, or the socket is closed.
Since:
1.4
See Also:
setReuseAddress(boolean) getReuseAddress() , bind(SocketAddress) , isBound() , isClosed()

toString getReuseAddress 


public String
public boolean toString getReuseAddress () ()
 throws SocketException
Returns the implementation address and implementation port of this socket as a String. Tests if SO_REUSEADDR is enabled.

Overrides: Returns:
toString a boolean indicating whether or not SO_REUSEADDR is enabled.
Throws:
SocketException in class Object
- if there is an error in the underlying protocol, such as a TCP error.
Since:
1.4
Returns: See Also:
a string representation of this socket. setReuseAddress(boolean)

setSocketFactory toString 


public static void 
public StringsetSocketFactory toString ( SocketImplFactory fac)
 throws IOException()
Sets the server socket implementation factory for the application. The factory can be specified only once. Returns the implementation address and implementation port of this socket as a String.

When an application creates a new server socket, the socket implementation factory's createSocketImpl method is called to create the actual socket implementation.

Passing null to the method is a no-op unless the factory was already set.

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: Overrides:
fac - the desired factory.
Throws:
IOException toString - if an I/O error occurs when setting the socket factory.
SocketException in class Object - if the factory has already been defined.
SecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation.
See Also: Returns:
SocketImplFactory.createSocketImpl() , SecurityManager.checkSetFactory() a string representation of this socket.

setReceiveBufferSize setSocketFactory 


public static void setReceiveBufferSize setSocketFactory (int size)
 throws SocketException( SocketImplFactory fac)
 throws IOException
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() . Sets the server socket implementation factory for the application. The factory can be specified only once.

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(). When an application creates a new server socket, the socket implementation factory's createSocketImpl method is called to create the actual socket implementation.

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. 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:
size - the size to which to set the receive buffer size. This value must be greater than 0. fac - the desired factory.
Throws:
IOException - if an I/O error occurs when setting the socket factory.
SocketException - if there is an error in the underlying protocol, such as a TCP error. - if the factory has already been defined.
IllegalArgumentException SecurityException - if the value is 0 or is negative. - if a security manager exists and its checkSetFactory method doesn't allow the operation.
Since:
1.4
See Also:
getReceiveBufferSize() SocketImplFactory.createSocketImpl() , SecurityManager.checkSetFactory()

getReceiveBufferSize setReceiveBufferSize 


public int void getReceiveBufferSize setReceiveBufferSize ()
 (int size)
 throws SocketException
Gets the Sets a default proposed value of for the SO_RCVBUF option for sockets accepted from this ServerSocket , that is the proposed buffer size that will be used 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() .

Note, the value actually set in the accepted socket is determined by calling Socket.getReceiveBufferSize() 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.

Returns: Parameters:
the value of the SO_RCVBUF option for this Socket . size - the size to which to set the receive buffer size. This value must be greater than 0.
Throws:
SocketException - if there is an error in the underlying protocol, such as a TCP error.
IllegalArgumentException - if the value is 0 or is negative.
Since:
1.4
See Also:
setReceiveBufferSize(int) getReceiveBufferSize()

setPerformancePreferences getReceiveBufferSize 


public void int setPerformancePreferences getReceiveBufferSize (int connectionTime,
 int latency,
 int bandwidth) ()
 throws SocketException
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 Gets the value of the SO_RCVBUF option for this (1, 0, 0) ServerSocket . 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 , that is the proposed buffer size that will be used for Sockets accepted from this (0, 1, 2) ServerSocket .

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. Note, the value actually set in the accepted socket is determined by calling Socket.getReceiveBufferSize() .

Parameters: Returns:
connectionTime - An the value of the SO_RCVBUF option for this int Socket expressing the relative importance of a short connection time .
Throws:
latency - An int expressing the relative importance of low latency
bandwidth - An int expressing the relative importance of high bandwidth SocketException - if there is an error in the underlying protocol, such as a TCP error.
Since:
1.5 1.4
See Also:
setReceiveBufferSize(int)