Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.net
Class Socket

java.lang.Object
  |
  +--java.net.Socket
public class Socket
extends Object

Untamed:

Field Summary
private  boolean bound
           
private  boolean closed
           
private  Object closeLock
           
private  boolean connected
           
private  boolean created
          Various states of this socket.
private static SocketImplFactory factory
          The factory for all client sockets.
(package private)  SocketImpl impl
          The implementation of this Socket.
private  boolean oldImpl
          Are we using an older SocketImpl?
private  boolean shutIn
           
private  boolean shutOut
           
 
Constructor Summary
  Socket()
          Enabled: Creates an unconnected socket, with the system-default type of SocketImpl.
  Socket(InetAddress address, int port)
          Enabled: Creates a stream socket and connects it to the specified port number at the specified IP address.
  Socket(InetAddress host, int port, boolean stream)
          Deprecated. Use DatagramSocket instead for UDP transport.
  Socket(InetAddress address, int port, InetAddress localAddr, int localPort)
          Enabled: Creates a socket and connects it to the specified remote address on the specified remote port.
private Socket(SocketAddress address, SocketAddress localAddr, boolean stream)
           
protected Socket(SocketImpl impl)
          Creates an unconnected Socket with a user-specified SocketImpl.
  Socket(String host, int port)
          Enabled: Creates a stream socket and connects it to the specified port number on the named host.
  Socket(String host, int port, boolean stream)
          Deprecated. Use DatagramSocket instead for UDP transport.
  Socket(String host, int port, InetAddress localAddr, int localPort)
          Enabled: Creates a socket and connects it to the specified remote host on the specified remote port.
 
Method Summary
 void bind(SocketAddress bindpoint)
          Enabled: Binds the socket to a local address.
private  void checkOldImpl()
           
 void close()
          Enabled: Closes this socket.
 void connect(SocketAddress endpoint)
          Enabled: Connects this socket to the server.
 void connect(SocketAddress endpoint, int timeout)
          Enabled: Connects this socket to the server with a specified timeout value.
(package private)  void createImpl(boolean stream)
          Creates the socket implementation.
 java.nio.channels.SocketChannel getChannel()
          Enabled: Returns the unique SocketChannel object associated with this socket, if any.
(package private)  SocketImpl getImpl()
          Get the SocketImpl attached to this socket, creating it if necessary.
 InetAddress getInetAddress()
          Enabled: Returns the address to which the socket is connected.
 InputStream getInputStream()
          Enabled: Returns an input stream for this socket.
 boolean getKeepAlive()
          Enabled: Tests if SO_KEEPALIVE is enabled.
 InetAddress getLocalAddress()
          Enabled: Gets the local address to which the socket is bound.
 int getLocalPort()
          Enabled: Returns the local port to which this socket is bound.
 SocketAddress getLocalSocketAddress()
          Enabled: Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
 boolean getOOBInline()
          Enabled: Tests if OOBINLINE is enabled.
 OutputStream getOutputStream()
          Enabled: Returns an output stream for this socket.
 int getPort()
          Enabled: Returns the remote port to which this socket is connected.
 int getReceiveBufferSize()
          Enabled: Gets the value of the SO_RCVBUF option for this Socket, that is the buffer size used by the platform for input on this Socket.
 SocketAddress getRemoteSocketAddress()
          Enabled: Returns the address of the endpoint this socket is connected to, or null if it is unconnected.
 boolean getReuseAddress()
          Enabled: Tests if SO_REUSEADDR is enabled.
 int getSendBufferSize()
          Enabled: Get value of the SO_SNDBUF option for this Socket, that is the buffer size used by the platform for output on this Socket.
 int getSoLinger()
          Enabled: Returns setting for SO_LINGER.
 int getSoTimeout()
          Enabled: Returns setting for SO_TIMEOUT.
 boolean getTcpNoDelay()
          Enabled: Tests if TCP_NODELAY is enabled.
 int getTrafficClass()
          Enabled: Gets traffic class or type-of-service in the IP header for packets sent from this Socket
 boolean isBound()
          Enabled: Returns the binding state of the socket.
 boolean isClosed()
          Enabled: Returns the closed state of the socket.
 boolean isConnected()
          Enabled: Returns the connection state of the socket.
 boolean isInputShutdown()
          Enabled: Returns wether the read-half of the socket connection is closed.
 boolean isOutputShutdown()
          Enabled: Returns wether the write-half of the socket connection is closed.
(package private)  void postAccept()
          set the flags after an accept() call.
 void sendUrgentData(int data)
          Enabled: Send one byte of urgent data on the socket.
(package private)  void setBound()
           
(package private)  void setConnected()
           
(package private)  void setCreated()
           
(package private)  void setImpl()
          Sets impl to the system-default type of SocketImpl.
 void setKeepAlive(boolean on)
          Enabled: Enable/disable SO_KEEPALIVE.
 void setOOBInline(boolean on)
          Enabled: Enable/disable OOBINLINE (receipt of TCP urgent data) By default, this option is disabled and TCP urgent data received on a socket is silently discarded.
 void setReceiveBufferSize(int size)
          Enabled: Sets the SO_RCVBUF option to the specified value for this Socket.
 void setReuseAddress(boolean on)
          Enabled: Enable/disable the SO_REUSEADDR socket option.
 void setSendBufferSize(int size)
          Enabled: Sets the SO_SNDBUF option to the specified value for this Socket.
static void setSocketImplFactory(SocketImplFactory fac)
          Enabled: Sets the client socket implementation factory for the application.
 void setSoLinger(boolean on, int linger)
          Enabled: Enable/disable SO_LINGER with the specified linger time in seconds.
 void setSoTimeout(int timeout)
          Enabled: Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
 void setTcpNoDelay(boolean on)
          Enabled: Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
 void setTrafficClass(int tc)
          Enabled: Sets traffic class or type-of-service octet in the IP header for packets sent from this Socket.
 void shutdownInput()
          Enabled: Places the input stream for this socket at "end of stream".
 void shutdownOutput()
          Enabled: Disables the output stream for this socket.
 String toString()
          Suppressed: Converts this socket to a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

created

private boolean created
Various states of this socket.

bound

private boolean bound

connected

private boolean connected

closed

private boolean closed

closeLock

private Object closeLock

shutIn

private boolean shutIn

shutOut

private boolean shutOut

impl

SocketImpl impl
The implementation of this Socket.

oldImpl

private boolean oldImpl
Are we using an older SocketImpl?

factory

private static SocketImplFactory factory
The factory for all client sockets.

Constructor Detail

Socket

public Socket()
Enabled: Creates an unconnected socket, with the system-default type of SocketImpl.

Since:
JDK1.1

Socket

protected Socket(SocketImpl impl)
          throws SocketException
Creates an unconnected Socket with a user-specified SocketImpl.

Parameters:
impl - an instance of a SocketImpl the subclass wishes to use on the Socket.
Since:
JDK1.1

Socket

public Socket(String host,
              int port)
       throws UnknownHostException,
              IOException
Enabled: Creates a stream socket and connects it to the specified port number on the named host.

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 checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

Parameters:
host - the host name.
port - the port number.
See Also:
java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory), java.net.SocketImpl, java.net.SocketImplFactory#createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(InetAddress address,
              int port)
       throws IOException
Enabled: Creates a stream socket and connects it to the specified port number at the specified IP address.

If the application has specified a 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 checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

Parameters:
address - the IP address.
port - the port number.
See Also:
java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory), java.net.SocketImpl, java.net.SocketImplFactory#createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(String host,
              int port,
              InetAddress localAddr,
              int localPort)
       throws IOException
Enabled: Creates a socket and connects it to the specified remote host on the specified remote port. The Socket will also bind() to the local address and port supplied.

If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

Parameters:
host - the name of the remote host
port - the remote port
localAddr - the local address the socket is bound to
localPort - the local port the socket is bound to
Since:
JDK1.1
See Also:
SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(InetAddress address,
              int port,
              InetAddress localAddr,
              int localPort)
       throws IOException
Enabled: Creates a socket and connects it to the specified remote address on the specified remote port. The Socket will also bind() to the local address and port supplied.

If there is a security manager, its checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

Parameters:
address - the remote address
port - the remote port
localAddr - the local address the socket is bound to
localPort - the local port the socket is bound to
Since:
JDK1.1
See Also:
SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(String host,
              int port,
              boolean stream)
       throws IOException
Deprecated. Use DatagramSocket instead for UDP transport.

Enabled: Creates a stream socket and connects it to the specified port number on the named host.

If the stream argument is true, this creates a stream socket. If the stream argument is false, it creates a datagram socket.

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 checkConnect method is called with the host address and port as its arguments. This could result in a SecurityException.

If a UDP socket is used, TCP/IP related socket options will not apply.

Parameters:
host - the host name.
port - the port number.
stream - a boolean indicating whether this is a stream socket or a datagram socket.
See Also:
java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory), java.net.SocketImpl, java.net.SocketImplFactory#createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

public Socket(InetAddress host,
              int port,
              boolean stream)
       throws IOException
Deprecated. Use DatagramSocket instead for UDP transport.

Enabled: Creates a socket and connects it to the specified port number at the specified IP address.

If the stream argument is true, this creates a stream socket. If the stream argument is false, it creates a datagram socket.

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 checkConnect method is called with host.getHostAddress() and port as its arguments. This could result in a SecurityException.

If UDP socket is used, TCP/IP related socket options will not apply.

Parameters:
host - the IP address.
port - the port number.
stream - if true, create a stream socket; otherwise, create a datagram socket.
See Also:
java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory), java.net.SocketImpl, java.net.SocketImplFactory#createSocketImpl(), SecurityManager.checkConnect(java.lang.String, int)

Socket

private Socket(SocketAddress address,
               SocketAddress localAddr,
               boolean stream)
        throws IOException
Method Detail

createImpl

void createImpl(boolean stream)
          throws SocketException
Creates the socket implementation.

Parameters:
stream - a boolean value : true for a TCP socket, false for UDP.
Throws:
IOException - if creation fails
SocketException
Since:
1.4

checkOldImpl

private void checkOldImpl()

setImpl

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

Since:
1.4

getImpl

SocketImpl getImpl()
             throws SocketException
Get the SocketImpl attached to this socket, creating it if necessary.

Returns:
the SocketImpl attached to that ServerSocket.
Throws:
SocketException - if creation fails
Since:
1.4

connect

public void connect(SocketAddress endpoint)
             throws IOException
Enabled: Connects this socket to the server.

Parameters:
endpoint - the SocketAddress
Throws:
IOException - if an error occurs during the connection
java.nio.channels.IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode
IllegalArgumentException - if endpoint is null or is a SocketAddress subclass not supported by this socket
Since:
1.4

connect

public void connect(SocketAddress endpoint,
                    int timeout)
             throws IOException
Enabled: Connects this socket to the server with a specified timeout value. A timeout of zero is interpreted as an infinite timeout. The connection will then block until established or an error occurs.

Parameters:
endpoint - the SocketAddress
timeout - the timeout value to be used in milliseconds.
Throws:
IOException - if an error occurs during the connection
SocketTimeoutException - if timeout expires before connecting
java.nio.channels.IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode
IllegalArgumentException - if endpoint is null or is a SocketAddress subclass not supported by this socket
Since:
1.4

bind

public void bind(SocketAddress bindpoint)
          throws IOException
Enabled: Binds the socket to a local address.

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

Parameters:
bindpoint - the SocketAddress to bind to
Throws:
IOException - if the bind operation fails, or if the socket is already bound.
IllegalArgumentException - if bindpoint is a SocketAddress subclass not supported by this socket
Since:
1.4
See Also:
isBound()

postAccept

final void postAccept()
set the flags after an accept() call.

setCreated

void setCreated()

setBound

void setBound()

setConnected

void setConnected()

getInetAddress

public InetAddress getInetAddress()
Enabled: Returns the address to which the socket is connected.

Returns:
the remote IP address to which this socket is connected, or null if the socket is not connected.

getLocalAddress

public InetAddress getLocalAddress()
Enabled: Gets the local address to which the socket is bound.

Returns:
the local address to which the socket is bound or InetAddress.anyLocalAddress() if the socket is not bound yet.
Since:
JDK1.1

getPort

public int getPort()
Enabled: Returns the remote port to which this socket is connected.

Returns:
the remote port number to which this socket is connected, or 0 if the socket is not connected yet.

getLocalPort

public int getLocalPort()
Enabled: Returns the local port to which this socket is bound.

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

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()
Enabled: Returns the address of the endpoint this socket is connected to, or null if it is unconnected.

Returns:
a SocketAddress reprensenting the remote endpoint of this socket, or null if it is not connected yet.
Since:
1.4
See Also:
getInetAddress(), getPort(), connect(SocketAddress, int), connect(SocketAddress)

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()
Enabled: 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.
Since:
1.4
See Also:
getLocalAddress(), getLocalPort(), bind(SocketAddress)

getChannel

public java.nio.channels.SocketChannel getChannel()
Enabled: Returns the unique SocketChannel object associated with this socket, if any.

A socket will have a channel if, and only if, the channel itself was created via the SocketChannel.open or ServerSocketChannel.accept methods.

Returns:
the socket channel associated with this socket, or null if this socket was not created for a channel
Since:
1.4

getInputStream

public InputStream getInputStream()
                           throws IOException
Enabled: Returns an input stream for this socket.

If this socket has an associated channel then the resulting input stream delegates all of its operations to the channel. If the channel is in non-blocking mode then the input stream's read operations will throw an java.nio.channels.IllegalBlockingModeException.

Under abnormal conditions the underlying connection may be broken by the remote host or the network software (for example a connection reset in the case of TCP connections). When a broken connection is detected by the network software the following applies to the returned input stream :-

Returns:
an input stream for reading bytes from this socket.
IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException
Enabled: Returns an output stream for this socket.

If this socket has an associated channel then the resulting output stream delegates all of its operations to the channel. If the channel is in non-blocking mode then the output stream's write operations will throw an java.nio.channels.IllegalBlockingModeException.

Returns:
an output stream for writing bytes to this socket.
IOException

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException
Enabled: Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

Parameters:
on - true to enable TCP_NODELAY, false to disable.
SocketException
Since:
JDK1.1
See Also:
getTcpNoDelay()

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException
Enabled: Tests if TCP_NODELAY is enabled.

Returns:
a boolean indicating whether or not TCP_NODELAY is enabled.
SocketException
Since:
JDK1.1
See Also:
setTcpNoDelay(boolean)

setSoLinger

public void setSoLinger(boolean on,
                        int linger)
                 throws SocketException
Enabled: Enable/disable SO_LINGER with the specified linger time in seconds. The maximum timeout value is platform specific. The setting only affects socket close.

Parameters:
on - whether or not to linger on.
linger - how long to linger for, if on is true.
SocketException
Since:
JDK1.1
See Also:
getSoLinger()

getSoLinger

public int getSoLinger()
                throws SocketException
Enabled: Returns setting for SO_LINGER. -1 returns implies that the option is disabled. The setting only affects socket close.

Returns:
the setting for SO_LINGER.
SocketException
Since:
JDK1.1
See Also:
setSoLinger(boolean, int)

sendUrgentData

public void sendUrgentData(int data)
                    throws IOException
Enabled: Send one byte of urgent data on the socket. The byte to be sent is the lowest eight bits of the data parameter. The urgent byte is sent after any preceding writes to the socket OutputStream and before any future writes to the OutputStream.

Parameters:
data - The byte of data to send
IOException
Since:
1.4

setOOBInline

public void setOOBInline(boolean on)
                  throws SocketException
Enabled: Enable/disable OOBINLINE (receipt of TCP urgent data) By default, this option is disabled and TCP urgent data received on a socket is silently discarded. If the user wishes to receive urgent data, then this option must be enabled. When enabled, urgent data is received inline with normal data.

Note, only limited support is provided for handling incoming urgent data. In particular, no notification of incoming urgent data is provided and there is no capability to distinguish between normal data and urgent data unless provided by a higher level protocol.

Parameters:
on - true to enable OOBINLINE, false to disable.
SocketException
Since:
1.4
See Also:
getOOBInline()

getOOBInline

public boolean getOOBInline()
                     throws SocketException
Enabled: Tests if OOBINLINE is enabled.

Returns:
a boolean indicating whether or not OOBINLINE is enabled.
SocketException
Since:
1.4
See Also:
setOOBInline(boolean)

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException
Enabled: Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a read() call on the InputStream associated with this Socket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException is raised, though the Socket 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.
SocketException
Since:
JDK 1.1
See Also:
getSoTimeout()

getSoTimeout

public int getSoTimeout()
                 throws SocketException
Enabled: Returns setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).

Returns:
the setting for SO_TIMEOUT
SocketException
Since:
JDK1.1
See Also:
setSoTimeout(int)

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException
Enabled: Sets the SO_SNDBUF option to the specified value for this Socket. The SO_SNDBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.

Because SO_SNDBUF is a hint, applications that want to verify what size the buffers were set to should call getSendBufferSize().

Parameters:
size - the size to which to set the send buffer size. This value must be greater than 0.
SocketException
Since:
1.2
See Also:
getSendBufferSize()

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException
Enabled: Get value of the SO_SNDBUF option for this Socket, that is the buffer size used by the platform for output on this Socket.

Returns:
the value of the SO_SNDBUF option for this Socket.
SocketException
Since:
1.2
See Also:
setSendBufferSize(int)

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException
Enabled: Sets the SO_RCVBUF option to the specified value for this Socket. The SO_RCVBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.

Increasing the receive buffer size can increase the performance of network I/O for high-volume connection, while decreasing it can help reduce the backlog of incoming data.

Because SO_RCVBUF is a hint, applications that want to verify what size the buffers were set to should call getReceiveBufferSize().

The value of SO_RCVBUF is also used to set the TCP receive window that is advertized to the remote peer. Generally, the window size can be modified at any time when a socket is connected. However, if a receive window larger than 64K is required then this must be requested before the socket is connected to the remote peer. There are two cases to be aware of:

  1. For sockets accepted from a ServerSocket, this must be done by calling ServerSocket.setReceiveBufferSize(int) before the ServerSocket is bound to a local address.

  2. For client sockets, setReceiveBufferSize() must be called before connecting the socket to its remote peer.

Parameters:
size - the size to which to set the receive buffer size. This value must be greater than 0.
SocketException
Since:
1.2
See Also:
getReceiveBufferSize(), ServerSocket.setReceiveBufferSize(int)

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException
Enabled: Gets the value of the SO_RCVBUF option for this Socket, that is the buffer size used by the platform for input on this Socket.

Returns:
the value of the SO_RCVBUF option for this Socket.
SocketException
Since:
1.2
See Also:
setReceiveBufferSize(int)

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException
Enabled: Enable/disable SO_KEEPALIVE.

Parameters:
on - whether or not to have socket keep alive turned on.
SocketException
Since:
1.3
See Also:
getKeepAlive()

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException
Enabled: Tests if SO_KEEPALIVE is enabled.

Returns:
a boolean indicating whether or not SO_KEEPALIVE is enabled.
SocketException
Since:
1.3
See Also:
setKeepAlive(boolean)

setTrafficClass

public void setTrafficClass(int tc)
                     throws SocketException
Enabled: Sets traffic class or type-of-service octet in the IP header for packets sent from this Socket. As the underlying network implementation may ignore this value applications should consider it a hint.

The tc must be in the range 0 <= tc <= 255 or an IllegalArgumentException will be thrown.

Notes:

for Internet Protocol v4 the value consists of an octet with precedence and TOS fields as detailed in RFC 1349. The TOS field is bitset created by bitwise-or'ing values such the following :-

The last low order bit is always ignored as this corresponds to the MBZ (must be zero) bit.

Setting bits in the precedence field may result in a SocketException indicating that the operation is not permitted.

for Internet Protocol v6 tc is the value that would be placed into the sin6_flowinfo field of the IP header.

Parameters:
tc - an int value for the bitset.
Throws:
SocketException - if there is an error setting the traffic class or type-of-service
Since:
1.4
See Also:
getTrafficClass()

getTrafficClass

public int getTrafficClass()
                    throws SocketException
Enabled: Gets traffic class or type-of-service in the IP header for packets sent from this Socket

As the underlying network implementation may ignore the traffic class or type-of-service set using #setTrafficClass() this method may return a different value than was previously set using the #setTrafficClass() method on this Socket.

Returns:
the traffic class or type-of-service already set
Throws:
SocketException - if there is an error obtaining the traffic class or type-of-service value.
Since:
1.4
See Also:
setTrafficClass(int)

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException
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 Socket is created the initial setting of SO_REUSEADDR is disabled.

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
SocketException
Since:
1.4
See Also:
getReuseAddress(), bind(SocketAddress), isClosed(), isBound()

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException
Enabled: Tests if SO_REUSEADDR is enabled.

Returns:
a boolean indicating whether or not SO_REUSEADDR is enabled.
SocketException
Since:
1.4
See Also:
setReuseAddress(boolean)

close

public void close()
           throws IOException
Enabled: Closes this socket.

Any thread currently blocked in an I/O operation upon this socket will throw a SocketException.

Once a socket has been closed, it is not available for further networking use (i.e. can't be reconnected or rebound). A new socket needs to be created.

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

IOException
See Also:
isClosed()

shutdownInput

public void shutdownInput()
                   throws IOException
Enabled: Places the input stream for this socket at "end of stream". Any data sent to the input stream side of the socket is acknowledged and then silently discarded.

If you read from a socket input stream after invoking shutdownInput() on the socket, the stream will return EOF.

IOException
Since:
1.3
See Also:
java.net.Socket#shutdownOutput(), java.net.Socket#close(), java.net.Socket#setSoLinger(boolean, int), isInputShutdown()

shutdownOutput

public void shutdownOutput()
                    throws IOException
Enabled: Disables the output stream for this socket. For a TCP socket, any previously written data will be sent followed by TCP's normal connection termination sequence. If you write to a socket output stream after invoking shutdownOutput() on the socket, the stream will throw an IOException.

IOException
Since:
1.3
See Also:
java.net.Socket#shutdownInput(), java.net.Socket#close(), java.net.Socket#setSoLinger(boolean, int), isOutputShutdown()

toString

public String toString()
Suppressed: Converts this socket to a String.

Overrides:
toString in class Object
Returns:
a string representation of this socket.

isConnected

public boolean isConnected()
Enabled: Returns the connection state of the socket.

Returns:
true if the socket successfuly connected to a server
Since:
1.4

isBound

public boolean isBound()
Enabled: Returns the binding state of the socket.

Returns:
true if the socket successfuly bound to an address
Since:
1.4
See Also:
bind(java.net.SocketAddress)

isClosed

public boolean isClosed()
Enabled: Returns the closed state of the socket.

Returns:
true if the socket has been closed
Since:
1.4
See Also:
close()

isInputShutdown

public boolean isInputShutdown()
Enabled: Returns wether the read-half of the socket connection is closed.

Returns:
true if the input of the socket has been shutdown
Since:
1.4
See Also:
shutdownInput()

isOutputShutdown

public boolean isOutputShutdown()
Enabled: Returns wether the write-half of the socket connection is closed.

Returns:
true if the output of the socket has been shutdown
Since:
1.4
See Also:
shutdownOutput()

setSocketImplFactory

public static void setSocketImplFactory(SocketImplFactory fac)
                                 throws IOException
Enabled: Sets the client socket implementation factory for the application. The factory can be specified only once.

When an application creates a new client 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.
IOException
See Also:
java.net.SocketImplFactory#createSocketImpl(), SecurityManager.checkSetFactory()
Overview  Package   Class  Tree  Deprecated  Index  Help  Legend 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
comments?