java::net::Socket Class Reference

Inheritance diagram for java::net::Socket:

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

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

List of all members.


Detailed Description

This class implements client sockets (also called just "sockets").

A socket is an endpoint for communication between two machines.

The actual work of the socket is performed by an instance of the SocketImpl class. An application, by changing the socket factory that creates the socket implementation, can configure itself to create sockets appropriate to the local firewall.

Author:
unascribed
Version:
1.90, 12/03/01
See also:
java.net.Socket::setSocketImplFactory(java.net.SocketImplFactory)

java.net.SocketImpl

java.nio.channels.SocketChannel

Since:
JDK1.0

Public Member Functions

 Socket ()
 Creates an unconnected socket, with the system-default type of SocketImpl.
 Socket (const String &host, jint port)
 Creates a stream socket and connects it to the specified port number on the named host.
 Socket (const Ref< InetAddress > &address, jint port)
 Creates a stream socket and connects it to the specified port number at the specified IP address.
 Socket (const String &host, jint port, const Ref< InetAddress > &localAddr, jint localPort=0)
 Creates a socket and connects it to the specified remote host on the specified remote port.
 Socket (const Ref< InetAddress > &address, jint port, const Ref< InetAddress > &localAddr, jint localPort=0)
 Creates a socket and connects it to the specified remote address on the specified remote port.
virtual Ref< SocketImplgetImpl () const
 Get the SocketImpl attached to this socket, creating it if necessary.
virtual jboolean isConnected () const
 Returns the connection state of the socket.
virtual jboolean isBound () const
 Returns the binding state of the socket.
virtual jboolean isClosed () const
 Returns the closed state of the socket.
virtual jboolean isInputShutdown () const
 Returns wether the read-half of the socket connection is closed.
virtual jboolean isOutputShutdown () const
 Returns wether the write-half of the socket connection is closed.
virtual Ref
< InetAddress
getInetAddress () const
 Returns the address to which the socket is connected.
virtual jint getPort () const
 Returns the remote port to which this socket is connected.
virtual Ref
< InetAddress
getLocalAddress () const
 Gets the local address to which the socket is bound.
virtual jint getLocalPort () const
 Returns the local port to which this socket is bound.
virtual Ref
< SocketAddress
getRemoteSocketAddress () const
 Returns the address of the endpoint this socket is connected to, or null if it is unconnected.
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 void connect (const Ref< SocketAddress > &endpoint, jint timeout=0)
 Connects this socket to the server with a specified timeout value.
virtual void bind (const Ref< SocketAddress > &bindpoint)
 Binds the socket to a local address.
virtual Ref
< InputStream
getInputStream ()
 Returns an input stream for this socket.
virtual Ref
< OutputStream
getOutputStream ()
 Returns an output stream for this socket.
virtual void setTcpNoDelay (jboolean on)
 Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
virtual jboolean getTcpNoDelay () const
 Tests if TCP_NODELAY is enabled.
virtual void setSoLinger (jboolean on, jint linger)
 Enable/disable SO_LINGER with the specified linger time in seconds.
virtual jint getSoLinger () const
 Returns setting for SO_LINGER.
virtual void sendUrgentData (jint data)
 Send one byte of urgent data on the socket.
virtual void setOOBInline (jboolean on)
 Enable/disable OOBINLINE (receipt of TCP urgent data).
virtual jboolean getOOBInline () const
 Tests if OOBINLINE is enabled.
virtual void setSoTimeout (jint timeout)
 Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
virtual jint getSoTimeout () const
 Returns setting for SO_TIMEOUT.
virtual void setSendBufferSize (jint size)
 Sets the SO_SNDBUF option to the specified value for this Socket.
virtual jint getSendBufferSize () const
 Get value of the SO_SNDBUF option for this Socket, that is the buffer size used by the platform for output on this Socket.
virtual void setReceiveBufferSize (jint size)
 Sets the SO_RCVBUF option to the specified value for this Socket.
virtual jint getReceiveBufferSize () const
 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.
virtual void setKeepAlive (jboolean on)
 Enable/disable SO_KEEPALIVE.
virtual jboolean getKeepAlive () const
 Tests if SO_KEEPALIVE is enabled.
virtual void setTrafficClass (jint tc)
 Sets traffic class or type-of-service octet in the IP header for packets sent from this Socket.
virtual jint getTrafficClass () const
 Gets traffic class or type-of-service in the IP header for packets sent from this Socket.
virtual void setReuseAddress (jboolean on)
 Enable/disable the SO_REUSEADDR socket option.
virtual jboolean getReuseAddress () const
 Tests if SO_REUSEADDR is enabled.
virtual void close ()
 Closes this socket.
virtual void shutdownInput ()
 Places the input stream for this socket at "end of stream".
virtual void shutdownOutput ()
 Disables the output stream for this socket.
virtual String toString () const
 Converts this socket to a String.

Static Public Member Functions

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

Protected Member Functions

 Socket (const Ref< SocketImpl > &impl)
 Creates an unconnected Socket with a user-specified SocketImpl.
virtual void setImpl ()
 Sets impl to the system-default type of SocketImpl.
void init (const Ref< SocketAddress > &address, const Ref< SocketAddress > &localAddr)

Constructor & Destructor Documentation

java::net::Socket::Socket (  ) 

Creates an unconnected socket, with the system-default type of SocketImpl.

Since:
JDK1.1 1.4

java::net::Socket::Socket ( const String host,
jint  port 
)

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

If the specified host is null it is the equivalent of specifying the address as InetAddress.getByName(null). In other words, it is equivalent to specifying an address of the loopback interface.

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, or null for the loopback address.
port the port number.
Exceptions:
UnknownHostException if the IP address of the host could not be determined.
IOException if an I/O error occurs when creating the socket.
SecurityException if a security manager exists and its checkConnect method doesn't allow the operation.
See also:
java.net.Socket::setSocketImplFactory(java.net.SocketImplFactory)

java.net.SocketImpl

java.net.SocketImplFactory::createSocketImpl()

SecurityManager::checkConnect

java::net::Socket::Socket ( const Ref< InetAddress > &  address,
jint  port 
)

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.
Exceptions:
IOException if an I/O error occurs when creating the socket.
SecurityException if a security manager exists and its checkConnect method doesn't allow the operation.
See also:
java.net.Socket::setSocketImplFactory(java.net.SocketImplFactory)

java.net.SocketImpl

java.net.SocketImplFactory::createSocketImpl()

SecurityManager::checkConnect

java::net::Socket::Socket ( const String host,
jint  port,
const Ref< InetAddress > &  localAddr,
jint  localPort = 0 
)

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 the specified host is null it is the equivalent of specifying the address as InetAddress.getByName(null). In other words, it is equivalent to specifying an address of the loopback interface.

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, or null for the loopback address.
port the remote port
localAddr the local address the socket is bound to
localPort the local port the socket is bound to
Exceptions:
IOException if an I/O error occurs when creating the socket.
SecurityException if a security manager exists and its checkConnect method doesn't allow the operation.
See also:
SecurityManager::checkConnect
Since:
JDK1.1

java::net::Socket::Socket ( const Ref< InetAddress > &  address,
jint  port,
const Ref< InetAddress > &  localAddr,
jint  localPort = 0 
)

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
Exceptions:
IOException if an I/O error occurs when creating the socket.
SecurityException if a security manager exists and its checkConnect method doesn't allow the operation.
See also:
SecurityManager::checkConnect
Since:
JDK1.1

java::net::Socket::Socket ( const Ref< SocketImpl > &  impl  )  [protected]

Creates an unconnected Socket with a user-specified SocketImpl.

Parameters:
impl an instance of a SocketImpl the subclass wishes to use on the Socket.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1


Member Function Documentation

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

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.
Exceptions:
IOException if an I/O error occurs when setting the socket factory.
SocketException if the factory is already 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 Ref<SocketImpl> java::net::Socket::getImpl (  )  const [virtual]

Get the SocketImpl attached to this socket, creating it if necessary.

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

virtual jboolean java::net::Socket::isConnected (  )  const [virtual]

Returns the connection state of the socket.

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

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

Returns the binding state of the socket.

Returns:
true if the socket successfuly bound to an address
Since:
1.4
See also:
bind

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

Returns the closed state of the socket.

Returns:
true if the socket has been closed
Since:
1.4
See also:
close

virtual jboolean java::net::Socket::isInputShutdown (  )  const [virtual]

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

virtual jboolean java::net::Socket::isOutputShutdown (  )  const [virtual]

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

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

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.

virtual jint java::net::Socket::getPort (  )  const [virtual]

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.

virtual Ref<InetAddress> java::net::Socket::getLocalAddress (  )  const [virtual]

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

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

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.

virtual Ref<SocketAddress> java::net::Socket::getRemoteSocketAddress (  )  const [virtual]

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.
See also:
getInetAddress()

getPort()

connect(SocketAddress, int)

connect(SocketAddress)

Since:
1.4

virtual Ref<SocketAddress> java::net::Socket::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:
getLocalAddress()

getLocalPort()

bind(SocketAddress)

Since:
1.4

virtual void java::net::Socket::connect ( const Ref< SocketAddress > &  endpoint,
jint  timeout = 0 
) [virtual]

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.
Exceptions:
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 JSR-51

virtual void java::net::Socket::bind ( const Ref< SocketAddress > &  bindpoint  )  [virtual]

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
Exceptions:
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

virtual Ref<InputStream> java::net::Socket::getInputStream (  )  [virtual]

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.
Exceptions:
IOException if an I/O error occurs when creating the input stream, the socket is closed, the socket is not connected, or the socket input has been shutdown using shutdownInput()
1.4 JSR-51

virtual Ref<OutputStream> java::net::Socket::getOutputStream (  )  [virtual]

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.
Exceptions:
IOException if an I/O error occurs when creating the output stream or if the socket is not connected. 1.4 JSR-51

virtual void java::net::Socket::setTcpNoDelay ( jboolean  on  )  [virtual]

Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).

Parameters:
on true to enable TCP_NODELAY, false to disable.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1
See also:
getTcpNoDelay()

virtual jboolean java::net::Socket::getTcpNoDelay (  )  const [virtual]

Tests if TCP_NODELAY is enabled.

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

virtual void java::net::Socket::setSoLinger ( jboolean  on,
jint  linger 
) [virtual]

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
IllegalArgumentException if the linger value is negative.
Since:
JDK1.1
See also:
getSoLinger()

virtual jint java::net::Socket::getSoLinger (  )  const [virtual]

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1
See also:
setSoLinger(boolean, int)

virtual void java::net::Socket::sendUrgentData ( jint  data  )  [virtual]

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
Exceptions:
IOException if there is an error sending the data.
Since:
1.4

virtual void java::net::Socket::setOOBInline ( jboolean  on  )  [virtual]

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
1.4
See also:
getOOBInline()

virtual jboolean java::net::Socket::getOOBInline (  )  const [virtual]

Tests if OOBINLINE is enabled.

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

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

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK 1.1
See also:
getSoTimeout()

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

Returns setting for SO_TIMEOUT.

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

Returns:
the setting for SO_TIMEOUT
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
JDK1.1
See also:
setSoTimeout(int)

virtual void java::net::Socket::setSendBufferSize ( jint  size  )  [virtual]

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().

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 send buffer size. This value must be greater than 0.
Exceptions:
IllegalArgumentException if the value is 0 or is negative.
See also:
getSendBufferSize()
Since:
1.2

virtual jint java::net::Socket::getSendBufferSize (  )  const [virtual]

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
See also:
setSendBufferSize(int)
Since:
1.2

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

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.
Exceptions:
IllegalArgumentException if the value is 0 or is negative.
SocketException if there is an error in the underlying protocol, such as a TCP error.
See also:
getReceiveBufferSize()

ServerSocket::setReceiveBufferSize(int)

Since:
1.2

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

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.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
See also:
setReceiveBufferSize(int)
Since:
1.2

virtual void java::net::Socket::setKeepAlive ( jboolean  on  )  [virtual]

Enable/disable SO_KEEPALIVE.

Parameters:
on whether or not to have socket keep alive turned on.
Exceptions:
SocketException if there is an error in the underlying protocol, such as a TCP error.
Since:
1.3
See also:
getKeepAlive()

virtual jboolean java::net::Socket::getKeepAlive (  )  const [virtual]

Tests if SO_KEEPALIVE is enabled.

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

virtual void java::net::Socket::setTrafficClass ( jint  tc  )  [virtual]

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.
Exceptions:
SocketException if there is an error setting the traffic class or type-of-service
Since:
1.4
See also:
getTrafficClass

virtual jint java::net::Socket::getTrafficClass (  )  const [virtual]

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
Exceptions:
SocketException if there is an error obtaining the traffic class or type-of-service value.
Since:
1.4
See also:
setTrafficClass

virtual void java::net::Socket::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 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
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)

isClosed()

isBound()

virtual jboolean java::net::Socket::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::Socket::close (  )  [virtual]

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.

Exceptions:
IOException if an I/O error occurs when closing this socket. 1.4 JSR-51
See also:
isClosed

virtual void java::net::Socket::shutdownInput (  )  [virtual]

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.

Exceptions:
IOException if an I/O error occurs when shutting down this socket.
Since:
1.3
See also:
java.net.Socket::shutdownOutput()

java.net.Socket::close()

java.net.Socket::setSoLinger(boolean, int)

isInputShutdown

virtual void java::net::Socket::shutdownOutput (  )  [virtual]

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.

Exceptions:
IOException if an I/O error occurs when shutting down this socket.
Since:
1.3
See also:
java.net.Socket::shutdownInput()

java.net.Socket::close()

java.net.Socket::setSoLinger(boolean, int)

isOutputShutdown

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

Converts this socket to a String.

Returns:
a string representation of this socket.

Reimplemented from java::lang::Object.

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

Sets impl to the system-default type of SocketImpl.

Since:
1.4

void java::net::Socket::init ( const Ref< SocketAddress > &  address,
const Ref< SocketAddress > &  localAddr 
) [protected]


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