| java.lang.Object java.net.Socket
Socket | public class Socket (Code) | | 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.56, 08/09/01 See Also: java.net.Socket.setSocketImplFactory(java.net.SocketImplFactory) See Also: java.net.SocketImpl since: JDK1.0 |
Constructor Summary | |
public | Socket() Creates an unconnected socket, with the
system-default type of SocketImpl. | protected | Socket(SocketImpl impl) Creates an unconnected Socket with a user-specified
SocketImpl.
Parameters: impl - an instance of a SocketImplthe subclass wishes to use on the Socket. exception: SocketException - if there is an error in the underlying protocol, such as a TCP error. | public | Socket(String host, int 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
java.net.InetAddress.getByName InetAddress.getByName (null).
In other words, it is equivalent to specifying an address of the
loopback interface. | public | Socket(InetAddress address, int 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. | public | Socket(String host, int port, InetAddress localAddr, int localPort) Creates a socket and connects it to the specified remote host on
the specified remote port. | public | Socket(InetAddress address, int port, InetAddress localAddr, int localPort) Creates a socket and connects it to the specified remote address on
the specified remote port. |
Method Summary | |
public void | bind(SocketAddress bindpoint) Binds the socket to a local address. | public synchronized void | close() 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. | public void | connect(SocketAddress endpoint) Connects this socket to the server. | public void | connect(SocketAddress endpoint, int timeout) Connects this socket to the server with a specified timeout value.
A timeout of zero is interpreted as an infinite timeout. | void | createImpl(boolean stream) Creates the socket implementation. | SocketImpl | getImpl() Get the SocketImpl attached to this socket, creating
it if necessary. | public InetAddress | getInetAddress() Returns the address to which the socket is connected. | public InputStream | getInputStream() 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. | public boolean | getKeepAlive() Tests if SO_KEEPALIVE is enabled.
a boolean indicating whether or not SO_KEEPALIVE is enabled. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public InetAddress | getLocalAddress() Gets the local address to which the socket is bound. | public int | getLocalPort() Returns the local port to which this socket is bound. | public SocketAddress | getLocalSocketAddress() Returns the address of the endpoint this socket is bound to, or
null if it is not bound yet. | public boolean | getOOBInline() Tests if OOBINLINE is enabled.
a boolean indicating whether or not OOBINLINE is enabled. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public OutputStream | getOutputStream() 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. | public int | getPort() Returns the remote port to which this socket is connected. | public synchronized int | getReceiveBufferSize() 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.
the value of the SO_RCVBUF option for this Socket. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public SocketAddress | getRemoteSocketAddress() Returns the address of the endpoint this socket is connected to, or
null if it is unconnected. | public boolean | getReuseAddress() Tests if SO_REUSEADDR is enabled.
a boolean indicating whether or not SO_REUSEADDR is enabled. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public synchronized int | getSendBufferSize() Get value of the SO_SNDBUF option for this Socket,
that is the buffer size used by the platform
for output on this Socket.
the value of the SO_SNDBUF option for this Socket. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public int | getSoLinger() Returns setting for SO_LINGER. | public synchronized int | getSoTimeout() Returns setting for SO_TIMEOUT. | public boolean | getTcpNoDelay() Tests if TCP_NODELAY is enabled.
a boolean indicating whether or not TCP_NODELAY is enabled. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public int | getTrafficClass() 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
Socket.setTrafficClass() this method may return a different value than was previously
set using the
Socket.setTrafficClass() method on this Socket. | public boolean | isBound() Returns the binding state of the socket. | public boolean | isClosed() Returns the closed state of the socket. | public boolean | isConnected() Returns the connection state of the socket. | public boolean | isInputShutdown() Returns wether the read-half of the socket connection is closed. | public boolean | isOutputShutdown() Returns wether the write-half of the socket connection is closed. | final void | postAccept() set the flags after an accept() call. | public void | sendUrgentData(int data) Send one byte of urgent data on the socket. | void | setBound() | void | setConnected() | void | setCreated() | void | setImpl() Sets impl to the system-default type of SocketImpl. | public void | setKeepAlive(boolean on) Enable/disable SO_KEEPALIVE.
Parameters: on - whether or not to have socket keep alive turned on. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. | public void | setOOBInline(boolean on) 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. | public synchronized void | setReceiveBufferSize(int size) Sets the SO_RCVBUF option to the specified value for this
Socket. | public void | setReuseAddress(boolean on) Enable/disable the SO_REUSEADDR socket option. | public synchronized void | setSendBufferSize(int size) Sets the SO_SNDBUF option to the specified value for this
Socket. | public void | setSoLinger(boolean on, int linger) Enable/disable SO_LINGER with the specified linger time in seconds. | public synchronized void | setSoTimeout(int timeout) Enable/disable SO_TIMEOUT with the specified timeout, in
milliseconds. | public static synchronized void | setSocketImplFactory(SocketImplFactory fac) Sets the client socket implementation factory for the
application. | public void | setTcpNoDelay(boolean on) Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm). | public void | setTrafficClass(int tc) 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. | public void | shutdownInput() Places the input stream for this socket at "end of stream". | public void | shutdownOutput() Disables the output stream for this socket. | public String | toString() Converts this socket to a String . |
Socket | public Socket()(Code) | | Creates an unconnected socket, with the
system-default type of SocketImpl.
since: JDK1.1 |
Socket | protected Socket(SocketImpl impl) throws SocketException(Code) | | Creates an unconnected Socket with a user-specified
SocketImpl.
Parameters: impl - an instance of a SocketImplthe subclass wishes to use on the Socket. exception: SocketException - if there is an error in the underlying protocol, such as a TCP error. since: JDK1.1 |
Socket | public Socket(String host, int port, InetAddress localAddr, int localPort) throws IOException(Code) | | 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
java.net.InetAddress.getByName 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. Parameters: port - the remote port Parameters: localAddr - the local address the socket is bound to Parameters: localPort - the local port the socket is bound to exception: IOException - if an I/O error occurs when creating the socket. exception: SecurityException - if a security manager exists and its checkConnect method doesn't allow the operation. See Also: SecurityManager.checkConnect since: JDK1.1 |
Socket | public Socket(InetAddress address, int port, InetAddress localAddr, int localPort) throws IOException(Code) | | 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 Parameters: port - the remote port Parameters: localAddr - the local address the socket is bound to Parameters: localPort - the local port the socket is bound to exception: IOException - if an I/O error occurs when creating the socket. exception: SecurityException - if a security manager exists and its checkConnect method doesn't allow the operation. See Also: SecurityManager.checkConnect since: JDK1.1 |
bind | public void bind(SocketAddress bindpoint) throws IOException(Code) | | 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 socketis already bound. throws: IllegalArgumentException - if bindpoint is aSocketAddress subclass not supported by this socket since: 1.4 See Also: Socket.isBound |
close | public synchronized void close() throws IOException(Code) | | 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.
exception: IOException - if an I/O error occurs when closing this socket. See Also: Socket.isClosed |
connect | public void connect(SocketAddress endpoint) throws IOException(Code) | | Connects this socket to the server.
Parameters: endpoint - the SocketAddress throws: IOException - if an error occurs during the connection throws: IllegalArgumentException - if endpoint is null or is aSocketAddress subclass not supported by this socket since: 1.4 |
connect | public void connect(SocketAddress endpoint, int timeout) throws IOException(Code) | | 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 Parameters: timeout - the timeout value to be used in milliseconds. throws: IOException - if an error occurs during the connection throws: SocketTimeoutException - if timeout expires before connecting throws: IllegalArgumentException - if endpoint is null or is aSocketAddress subclass not supported by this socket since: 1.4 |
createImpl | void createImpl(boolean stream) throws SocketException(Code) | | Creates the socket implementation.
Parameters: stream - a boolean value : true for a TCP socket,false for UDP. throws: IOException - if creation fails since: 1.4 |
getInetAddress | public InetAddress getInetAddress()(Code) | | Returns the address to which the socket is connected.
the remote IP address to which this socket is connected,or null if the socket is not connected. |
getInputStream | public InputStream getInputStream() throws IOException(Code) | | 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.
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 :-
an input stream for reading bytes from this socket. exception: IOException - if an I/O error occurs when creating theinput stream, the socket is closed, the socket isnot connected, or the socket input has been shutdownusing Socket.shutdownInput() |
getLocalAddress | public InetAddress getLocalAddress()(Code) | | Gets the local address to which the socket is bound.
the local address to which the socket is bound or InetAddress.anyLocalAddress() if the socket is not bound yet. since: JDK1.1 |
getLocalPort | public int getLocalPort()(Code) | | Returns the local port to which this socket is bound.
the local port number to which this socket is bound or -1if the socket is not bound yet. |
getOutputStream | public OutputStream getOutputStream() throws IOException(Code) | | 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.
an output stream for writing bytes to this socket. exception: IOException - if an I/O error occurs when creating theoutput stream or if the socket is not connected. |
getPort | public int getPort()(Code) | | Returns the remote port to which this socket is connected.
the remote port number to which this socket is connected, or0 if the socket is not connected yet. |
getReceiveBufferSize | public synchronized int getReceiveBufferSize() throws SocketException(Code) | | 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.
the value of the SO_RCVBUF option for this Socket. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. See Also: Socket.setReceiveBufferSize(int) since: 1.2 |
getSendBufferSize | public synchronized int getSendBufferSize() throws SocketException(Code) | | Get value of the SO_SNDBUF option for this Socket,
that is the buffer size used by the platform
for output on this Socket.
the value of the SO_SNDBUF option for this Socket. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. See Also: Socket.setSendBufferSize(int) since: 1.2 |
getSoLinger | public int getSoLinger() throws SocketException(Code) | | Returns setting for SO_LINGER. -1 returns implies that the
option is disabled.
The setting only affects socket close.
the setting for SO_LINGER. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. since: JDK1.1 See Also: Socket.setSoLinger(boolean,int) |
getSoTimeout | public synchronized int getSoTimeout() throws SocketException(Code) | | Returns setting for SO_TIMEOUT. 0 returns implies that the
option is disabled (i.e., timeout of infinity).
the setting for SO_TIMEOUT exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. since: JDK1.1 See Also: Socket.setSoTimeout(int) |
getTrafficClass | public int getTrafficClass() throws SocketException(Code) | | 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
Socket.setTrafficClass() this method may return a different value than was previously
set using the
Socket.setTrafficClass() method on this Socket.
the traffic class or type-of-service already set throws: SocketException - if there is an error obtaining thetraffic class or type-of-service value. since: 1.4 See Also: Socket.setTrafficClass |
isBound | public boolean isBound()(Code) | | Returns the binding state of the socket.
true if the socket successfuly bound to an address since: 1.4 See Also: Socket.bind |
isClosed | public boolean isClosed()(Code) | | Returns the closed state of the socket.
true if the socket has been closed since: 1.4 See Also: Socket.close |
isConnected | public boolean isConnected()(Code) | | Returns the connection state of the socket.
true if the socket successfuly connected to a server since: 1.4 |
isInputShutdown | public boolean isInputShutdown()(Code) | | Returns wether the read-half of the socket connection is closed.
true if the input of the socket has been shutdown since: 1.4 See Also: Socket.shutdownInput |
isOutputShutdown | public boolean isOutputShutdown()(Code) | | Returns wether the write-half of the socket connection is closed.
true if the output of the socket has been shutdown since: 1.4 See Also: Socket.shutdownOutput |
postAccept | final void postAccept()(Code) | | set the flags after an accept() call.
|
sendUrgentData | public void sendUrgentData(int data) throws IOException(Code) | | 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 exception: IOException - if there is an errorsending the data. since: 1.4 |
setBound | void setBound()(Code) | | |
setConnected | void setConnected()(Code) | | |
setCreated | void setCreated()(Code) | | |
setImpl | void setImpl()(Code) | | Sets impl to the system-default type of SocketImpl.
since: 1.4 |
setKeepAlive | public void setKeepAlive(boolean on) throws SocketException(Code) | | Enable/disable SO_KEEPALIVE.
Parameters: on - whether or not to have socket keep alive turned on. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. since: 1.3 See Also: Socket.getKeepAlive() |
setOOBInline | public void setOOBInline(boolean on) throws SocketException(Code) | | 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. exception: SocketException - if there is an error in the underlying protocol, such as a TCP error. since: 1.4 See Also: Socket.getOOBInline() |
setReceiveBufferSize | public synchronized void setReceiveBufferSize(int size) throws SocketException(Code) | | 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
Socket.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:
- For sockets accepted from a ServerSocket, this must be done by calling
ServerSocket.setReceiveBufferSize(int) before the ServerSocket
is bound to a local address.
- 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 buffersize. This value must be greater than 0. exception: IllegalArgumentException - if the value is 0 or isnegative. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. See Also: Socket.getReceiveBufferSize() See Also: ServerSocket.setReceiveBufferSize(int) since: 1.2 |
setReuseAddress | public void setReuseAddress(boolean on) throws SocketException(Code) | | 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
Socket.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
Socket.isBound() )
is not defined.
Parameters: on - whether to enable or disable the socket option exception: SocketException - if an error occurs enabling ordisabling the SO_RESUEADDR socket option,or the socket is closed. since: 1.4 See Also: Socket.getReuseAddress() See Also: See Also: Socket.bind(SocketAddress) See Also: Socket.isClosed() See Also: Socket.isBound() |
setSendBufferSize | public synchronized void setSendBufferSize(int size) throws SocketException(Code) | | 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
Socket.getSendBufferSize() .
exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. Parameters: size - the size to which to set the send buffersize. This value must be greater than 0. exception: IllegalArgumentException - if the value is 0 or is negative. See Also: Socket.getSendBufferSize() since: 1.2 |
setSoLinger | public void setSoLinger(boolean on, int linger) throws SocketException(Code) | | 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. Parameters: linger - how long to linger for, if on is true. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. exception: IllegalArgumentException - if the linger value is negative. since: JDK1.1 See Also: Socket.getSoLinger() |
setSoTimeout | public synchronized void setSoTimeout(int timeout) throws SocketException(Code) | | 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. exception: SocketException - if there is an errorin the underlying protocol, such as a TCP error. since: JDK 1.1 See Also: Socket.getSoTimeout() |
setSocketImplFactory | public static synchronized void setSocketImplFactory(SocketImplFactory fac) throws IOException(Code) | | 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. exception: IOException - if an I/O error occurs when setting thesocket factory. exception: SocketException - if the factory is already defined. exception: SecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation. See Also: java.net.SocketImplFactory.createSocketImpl See Also: SecurityManager.checkSetFactory |
setTcpNoDelay | public void setTcpNoDelay(boolean on) throws SocketException(Code) | | Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm).
Parameters: on - true to enable TCP_NODELAY, false to disable. exception: SocketException - if there is an error in the underlying protocol, such as a TCP error. since: JDK1.1 See Also: Socket.getTcpNoDelay() |
setTrafficClass | public void setTrafficClass(int tc) throws SocketException(Code) | | 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 :-
IPTOS_LOWCOST (0x02)
IPTOS_RELIABILITY (0x04)
IPTOS_THROUGHPUT (0x08)
IPTOS_LOWDELAY (0x10)
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 thetraffic class or type-of-service since: 1.4 See Also: Socket.getTrafficClass |
toString | public String toString()(Code) | | Converts this socket to a String .
a string representation of this socket. |
|
|