| Constructor: |
public Socket() {
setImpl();
}
Creates an unconnected socket, with the
system-default type of SocketImpl. - since:
JDK1.1 -
- revised:
1.4 -
|
public Socket(Proxy proxy) {
// Create a copy of Proxy as a security measure
if (proxy == null) {
throw new IllegalArgumentException("Invalid Proxy");
}
Proxy p = proxy == Proxy.NO_PROXY ? Proxy.NO_PROXY : sun.net.ApplicationProxy.create(proxy);
if (p.type() == Proxy.Type.SOCKS) {
SecurityManager security = System.getSecurityManager();
InetSocketAddress epoint = (InetSocketAddress) p.address();
if (epoint.getAddress() != null) {
checkAddress (epoint.getAddress(), "Socket");
}
if (security != null) {
if (epoint.isUnresolved())
epoint = new InetSocketAddress(epoint.getHostName(), epoint.getPort());
if (epoint.isUnresolved())
security.checkConnect(epoint.getHostName(), epoint.getPort());
else
security.checkConnect(epoint.getAddress().getHostAddress(),
epoint.getPort());
}
impl = new SocksSocketImpl(p);
impl.setSocket(this);
} else {
if (p == Proxy.NO_PROXY) {
if (factory == null) {
impl = new PlainSocketImpl();
impl.setSocket(this);
} else
setImpl();
} else
throw new IllegalArgumentException("Invalid Proxy");
}
}
Creates an unconnected socket, specifying the type of proxy, if any,
that should be used regardless of any other settings.
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.
Examples:
Socket s = new Socket(Proxy.NO_PROXY); will create
a plain socket ignoring any other proxy configuration.
Socket s = new Socket(new Proxy(Proxy.Type.SOCKS, new InetSocketAddress("socks.mydom.com", 1080)));
will create a socket connecting through the specified SOCKS proxy
server.
Parameters:
proxy - a Proxy object specifying what kind
of proxying should be used.
Throws:
IllegalArgumentException - if the proxy is of an invalid type
or null.
SecurityException - if a security manager is present and
permission to connect to the proxy is
denied.
Also see:
- java.net.ProxySelector
- java.net.Proxy
- since:
1.5 -
|
protected Socket(SocketImpl impl) throws SocketException {
this.impl = impl;
if (impl != null) {
checkOldImpl();
this.impl.setSocket(this);
}
}
Creates an unconnected Socket with a user-specified
SocketImpl.
Parameters:
impl - an instance of a SocketImpl
the subclass wishes to use on the Socket.
Throws:
SocketException - if there is an error in the underlying protocol,
such as a TCP error.
- exception:
SocketException - if there is an error in the underlying protocol,
such as a TCP error.
- since:
JDK1.1 -
|
public Socket(String host,
int port) throws UnknownHostException, IOException {
this(host != null ? new InetSocketAddress(host, port) :
new InetSocketAddress(InetAddress.getByName(null), port),
(SocketAddress) null, true);
}
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.
Throws:
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.
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
Also see:
- java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory)
- java.net.SocketImpl
- java.net.SocketImplFactory#createSocketImpl()
- SecurityManager#checkConnect
- exception:
UnknownHostException - if the IP address of
the host could not be determined.
- 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.
- exception:
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
|
public Socket(InetAddress address,
int port) throws IOException {
this(address != null ? new InetSocketAddress(address, port) : null,
(SocketAddress) null, true);
}
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.
Throws:
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.
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
NullPointerException - if address is null.
Also see:
- java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory)
- java.net.SocketImpl
- java.net.SocketImplFactory#createSocketImpl()
- SecurityManager#checkConnect
- 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.
- exception:
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
- exception:
NullPointerException - if address is null.
|
public Socket(String host,
int port,
boolean stream) throws IOException {
this(host != null ? new InetSocketAddress(host, port) :
new InetSocketAddress(InetAddress.getByName(null), port),
(SocketAddress) null, stream);
}
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 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, or null for the loopback address.
port - the port number.
stream - a boolean indicating whether this is
a stream socket or a datagram socket.
Throws:
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.
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
Also see:
- java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory)
- java.net.SocketImpl
- java.net.SocketImplFactory#createSocketImpl()
- SecurityManager#checkConnect
- 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.
- exception:
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
|
public Socket(InetAddress host,
int port,
boolean stream) throws IOException {
this(host != null ? new InetSocketAddress(host, port) : null,
new InetSocketAddress(0), stream);
}
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.
Throws:
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.
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
NullPointerException - if host is null.
Also see:
- java.net.Socket#setSocketImplFactory(java.net.SocketImplFactory)
- java.net.SocketImpl
- java.net.SocketImplFactory#createSocketImpl()
- SecurityManager#checkConnect
- 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.
- exception:
IllegalArgumentException - if the port parameter is outside
the specified range of valid port values, which is between
0 and 65535, inclusive.
- exception:
NullPointerException - if host is null.
|
public Socket(String host,
int port,
InetAddress localAddr,
int localPort) throws IOException {
this(host != null ? new InetSocketAddress(host, port) :
new InetSocketAddress(InetAddress.getByName(null), port),
new InetSocketAddress(localAddr, localPort), true);
}
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.
A local port number of zero will let the system pick up a
free port in the bind operation.
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, or
null for the anyLocal address.
localPort - the local port the socket is bound to, or
zero for a system selected free port.
Throws:
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.
IllegalArgumentException - if the port parameter or localPort
parameter is outside the specified range of valid port values,
which is between 0 and 65535, inclusive.
Also see:
- SecurityManager#checkConnect
- 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.
- exception:
IllegalArgumentException - if the port parameter or localPort
parameter is outside the specified range of valid port values,
which is between 0 and 65535, inclusive.
- since:
JDK1.1 -
|
public Socket(InetAddress address,
int port,
InetAddress localAddr,
int localPort) throws IOException {
this(address != null ? new InetSocketAddress(address, port) : null,
new InetSocketAddress(localAddr, localPort), true);
}
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 the specified local address is null it is the equivalent of
specifying the address as the AnyLocal address (see InetAddress.isAnyLocalAddress ()).
A local port number of zero will let the system pick up a
free port in the bind operation.
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, or
null for the anyLocal address.
localPort - the local port the socket is bound to or
zero for a system selected free port.
Throws:
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.
IllegalArgumentException - if the port parameter or localPort
parameter is outside the specified range of valid port values,
which is between 0 and 65535, inclusive.
NullPointerException - if address is null.
Also see:
- SecurityManager#checkConnect
- 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.
- exception:
IllegalArgumentException - if the port parameter or localPort
parameter is outside the specified range of valid port values,
which is between 0 and 65535, inclusive.
- exception:
NullPointerException - if address is null.
- since:
JDK1.1 -
|
| Method from java.net.Socket Detail: |
public void bind(SocketAddress bindpoint) throws IOException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!oldImpl && isBound())
throw new SocketException("Already bound");
if (bindpoint != null && (!(bindpoint instanceof InetSocketAddress)))
throw new IllegalArgumentException("Unsupported address type");
InetSocketAddress epoint = (InetSocketAddress) bindpoint;
if (epoint != null && epoint.isUnresolved())
throw new SocketException("Unresolved address");
if (epoint == null) {
epoint = new InetSocketAddress(0);
}
InetAddress addr = epoint.getAddress();
int port = epoint.getPort();
checkAddress (addr, "bind");
getImpl().bind (addr, port);
bound = true;
}
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. |
public synchronized void close() throws IOException {
synchronized(closeLock) {
if (isClosed())
return;
if (created)
impl.close();
closed = true;
}
}
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.
Closing this socket will also close the socket's
InputStream and
OutputStream .
If this socket has an associated channel then the channel is closed
as well. |
public void connect(SocketAddress endpoint) throws IOException {
connect(endpoint, 0);
}
Connects this socket to the server. |
public void connect(SocketAddress endpoint,
int timeout) throws IOException {
if (endpoint == null)
throw new IllegalArgumentException("connect: The address can't be null");
if (timeout < 0)
throw new IllegalArgumentException("connect: timeout can't be negative");
if (isClosed())
throw new SocketException("Socket is closed");
if (!oldImpl && isConnected())
throw new SocketException("already connected");
if (!(endpoint instanceof InetSocketAddress))
throw new IllegalArgumentException("Unsupported address type");
InetSocketAddress epoint = (InetSocketAddress) endpoint;
InetAddress addr = epoint.getAddress ();
int port = epoint.getPort();
checkAddress(addr, "connect");
SecurityManager security = System.getSecurityManager();
if (security != null) {
if (epoint.isUnresolved())
security.checkConnect(epoint.getHostName(), port);
else
security.checkConnect(addr.getHostAddress(), port);
}
if (!created)
createImpl(true);
if (!oldImpl)
impl.connect(epoint, timeout);
else if (timeout == 0) {
if (epoint.isUnresolved())
impl.connect(addr.getHostName(), port);
else
impl.connect(addr, port);
} else
throw new UnsupportedOperationException("SocketImpl.connect(addr, timeout)");
connected = true;
/*
* If the socket was not bound before the connect, it is now because
* the kernel will have picked an ephemeral port & a local address
*/
bound = true;
}
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. |
void createImpl(boolean stream) throws SocketException {
if (impl == null)
setImpl();
try {
impl.create(stream);
created = true;
} catch (IOException e) {
throw new SocketException(e.getMessage());
}
}
Creates the socket implementation. |
public SocketChannel getChannel() {
return null;
}
|
SocketImpl getImpl() throws SocketException {
if (!created)
createImpl(true);
return impl;
}
Get the SocketImpl attached to this socket, creating
it if necessary. |
public InetAddress getInetAddress() {
if (!isConnected())
return null;
try {
return getImpl().getInetAddress();
} catch (SocketException e) {
}
return null;
}
Returns the address to which the socket is connected.
If the socket was connected prior to being closed ,
then this method will continue to return the connected address
after the socket is closed. |
public InputStream getInputStream() throws IOException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!isConnected())
throw new SocketException("Socket is not connected");
if (isInputShutdown())
throw new SocketException("Socket input is shutdown");
final Socket s = this;
InputStream is = null;
try {
is = AccessController.doPrivileged(
new PrivilegedExceptionAction< InputStream >() {
public InputStream run() throws IOException {
return impl.getInputStream();
}
});
} catch (java.security.PrivilegedActionException e) {
throw (IOException) e.getException();
}
return is;
}
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 :-
The network software may discard bytes that are buffered
by the socket. Bytes that aren't discarded by the network
software can be read using read .
If there are no bytes buffered on the socket, or all
buffered bytes have been consumed by
read , then all subsequent
calls to read will throw an
IOException .
If there are no bytes buffered on the socket, and the
socket has not been closed using close , then
available will
return 0.
Closing the returned InputStream
will close the associated socket. |
public boolean getKeepAlive() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
return ((Boolean) getImpl().getOption(SocketOptions.SO_KEEPALIVE)).booleanValue();
}
Tests if SO_KEEPALIVE is enabled. |
public InetAddress getLocalAddress() {
// This is for backward compatibility
if (!isBound())
return InetAddress.anyLocalAddress();
InetAddress in = null;
try {
in = (InetAddress) getImpl().getOption(SocketOptions.SO_BINDADDR);
if (in.isAnyLocalAddress()) {
in = InetAddress.anyLocalAddress();
}
} catch (Exception e) {
in = InetAddress.anyLocalAddress(); // "0.0.0.0"
}
return in;
}
Gets the local address to which the socket is bound. |
public int getLocalPort() {
if (!isBound())
return -1;
try {
return getImpl().getLocalPort();
} catch(SocketException e) {
// shouldn't happen as we're bound
}
return -1;
}
Returns the local port number to which this socket is bound.
If the socket was bound prior to being closed ,
then this method will continue to return the local port number
after the socket is closed. |
public SocketAddress getLocalSocketAddress() {
if (!isBound())
return null;
return new InetSocketAddress(getLocalAddress(), getLocalPort());
}
Returns the address of the endpoint this socket is bound to, or
null if it is not bound yet.
If a socket bound to an endpoint represented by an
InetSocketAddress is closed ,
then this method will continue to return an InetSocketAddress
after the socket is closed. In that case the returned
InetSocketAddress's address is the
wildcard address
and its port is the local port that it was bound to. |
public boolean getOOBInline() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
return ((Boolean) getImpl().getOption(SocketOptions.SO_OOBINLINE)).booleanValue();
}
Tests if OOBINLINE is enabled. |
public OutputStream getOutputStream() throws IOException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!isConnected())
throw new SocketException("Socket is not connected");
if (isOutputShutdown())
throw new SocketException("Socket output is shutdown");
final Socket s = this;
OutputStream os = null;
try {
os = AccessController.doPrivileged(
new PrivilegedExceptionAction< OutputStream >() {
public OutputStream run() throws IOException {
return impl.getOutputStream();
}
});
} catch (java.security.PrivilegedActionException e) {
throw (IOException) e.getException();
}
return os;
}
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 .
Closing the returned OutputStream
will close the associated socket. |
public int getPort() {
if (!isConnected())
return 0;
try {
return getImpl().getPort();
} catch (SocketException e) {
// Shouldn't happen as we're connected
}
return -1;
}
Returns the remote port number to which this socket is connected.
If the socket was connected prior to being closed ,
then this method will continue to return the connected port number
after the socket is closed. |
public synchronized int getReceiveBufferSize() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
int result = 0;
Object o = getImpl().getOption(SocketOptions.SO_RCVBUF);
if (o instanceof Integer) {
result = ((Integer)o).intValue();
}
return result;
}
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. |
public SocketAddress getRemoteSocketAddress() {
if (!isConnected())
return null;
return new InetSocketAddress(getInetAddress(), getPort());
}
Returns the address of the endpoint this socket is connected to, or
null if it is unconnected.
If the socket was connected prior to being closed ,
then this method will continue to return the connected address
after the socket is closed. |
public boolean getReuseAddress() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
return ((Boolean) (getImpl().getOption(SocketOptions.SO_REUSEADDR))).booleanValue();
}
Tests if SO_REUSEADDR is enabled. |
public synchronized int getSendBufferSize() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
int result = 0;
Object o = getImpl().getOption(SocketOptions.SO_SNDBUF);
if (o instanceof Integer) {
result = ((Integer)o).intValue();
}
return result;
}
Get value of the SO_SNDBUF option for this Socket,
that is the buffer size used by the platform
for output on this Socket. |
public int getSoLinger() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
Object o = getImpl().getOption(SocketOptions.SO_LINGER);
if (o instanceof Integer) {
return ((Integer) o).intValue();
} else {
return -1;
}
}
Returns setting for SO_LINGER. -1 returns implies that the
option is disabled.
The setting only affects socket close. |
public synchronized int getSoTimeout() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
Object o = getImpl().getOption(SocketOptions.SO_TIMEOUT);
/* extra type safety */
if (o instanceof Integer) {
return ((Integer) o).intValue();
} else {
return 0;
}
}
Returns setting for SO_TIMEOUT. 0 returns implies that the
option is disabled (i.e., timeout of infinity). |
public boolean getTcpNoDelay() throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
return ((Boolean) getImpl().getOption(SocketOptions.TCP_NODELAY)).booleanValue();
}
Tests if TCP_NODELAY is enabled. |
public int getTrafficClass() throws SocketException {
return ((Integer) (getImpl().getOption(SocketOptions.IP_TOS))).intValue();
}
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(int)
this method may return a different value than was previously
set using the #setTrafficClass(int) method on this Socket. |
public boolean isBound() {
// Before 1.3 Sockets were always bound during creation
return bound || oldImpl;
}
Returns the binding state of the socket.
Note: Closing a socket doesn't clear its binding state, which means
this method will return true for a closed socket
(see #isClosed() ) if it was successfuly bound prior
to being closed. |
public boolean isClosed() {
synchronized(closeLock) {
return closed;
}
}
Returns the closed state of the socket. |
public boolean isConnected() {
// Before 1.3 Sockets were always connected during creation
return connected || oldImpl;
}
Returns the connection state of the socket.
Note: Closing a socket doesn't clear its connection state, which means
this method will return true for a closed socket
(see #isClosed() ) if it was successfuly connected prior
to being closed. |
public boolean isInputShutdown() {
return shutIn;
}
Returns whether the read-half of the socket connection is closed. |
public boolean isOutputShutdown() {
return shutOut;
}
Returns whether the write-half of the socket connection is closed. |
final void postAccept() {
connected = true;
created = true;
bound = true;
}
set the flags after an accept() call. |
public void sendUrgentData(int data) throws IOException {
if (!getImpl().supportsUrgentData ()) {
throw new SocketException ("Urgent data not supported");
}
getImpl().sendUrgentData (data);
}
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. |
void setBound() {
bound = true;
}
|
void setConnected() {
connected = true;
}
|
void setCreated() {
created = true;
}
|
void setImpl() {
if (factory != null) {
impl = factory.createSocketImpl();
checkOldImpl();
} else {
// No need to do a checkOldImpl() here, we know it's an up to date
// SocketImpl!
impl = new SocksSocketImpl();
}
if (impl != null)
impl.setSocket(this);
}
Sets impl to the system-default type of SocketImpl. |
public void setKeepAlive(boolean on) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.SO_KEEPALIVE, Boolean.valueOf(on));
}
Enable/disable SO_KEEPALIVE. |
public void setOOBInline(boolean on) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.SO_OOBINLINE, Boolean.valueOf(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. 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. |
public void setPerformancePreferences(int connectionTime,
int latency,
int bandwidth) {
/* Not implemented yet */
}
Sets performance preferences for this socket.
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. Negative
values represent a lower priority than positive values. 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
(1, 0, 0). 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 (0, 1, 2).
Invoking this method after this socket has been connected
will have no effect. |
public synchronized void setReceiveBufferSize(int size) throws SocketException {
if (size < = 0) {
throw new IllegalArgumentException("invalid receive size");
}
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.SO_RCVBUF, new Integer(size));
}
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:
- 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.
|
public void setReuseAddress(boolean on) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.SO_REUSEADDR, Boolean.valueOf(on));
}
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. |
public synchronized void setSendBufferSize(int size) throws SocketException {
if (!(size > 0)) {
throw new IllegalArgumentException("negative send size");
}
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.SO_SNDBUF, new Integer(size));
}
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() . |
public void setSoLinger(boolean on,
int linger) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!on) {
getImpl().setOption(SocketOptions.SO_LINGER, new Boolean(on));
} else {
if (linger < 0) {
throw new IllegalArgumentException("invalid value for SO_LINGER");
}
if (linger > 65535)
linger = 65535;
getImpl().setOption(SocketOptions.SO_LINGER, new Integer(linger));
}
}
Enable/disable SO_LINGER with the specified linger time in seconds.
The maximum timeout value is platform specific.
The setting only affects socket close. |
public synchronized void setSoTimeout(int timeout) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
if (timeout < 0)
throw new IllegalArgumentException("timeout can't be negative");
getImpl().setOption(SocketOptions.SO_TIMEOUT, new Integer(timeout));
}
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. |
public static synchronized void setSocketImplFactory(SocketImplFactory fac) throws IOException {
if (factory != null) {
throw new SocketException("factory already defined");
}
SecurityManager security = System.getSecurityManager();
if (security != null) {
security.checkSetFactory();
}
factory = fac;
}
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.
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. |
public void setTcpNoDelay(boolean on) throws SocketException {
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.TCP_NODELAY, Boolean.valueOf(on));
}
Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm). |
public void setTrafficClass(int tc) throws SocketException {
if (tc < 0 || tc > 255)
throw new IllegalArgumentException("tc is not in range 0 -- 255");
if (isClosed())
throw new SocketException("Socket is closed");
getImpl().setOption(SocketOptions.IP_TOS, new Integer(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
integer, the least significant 8 bits of which
represent the value of the TOS octet in IP packets sent by
the socket.
RFC 1349 defines the TOS values as follows:
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.
As RFC 1122 section 4.2.4.2 indicates, a compliant TCP
implementation should, but is not required to, let application
change the TOS field during the lifetime of a connection.
So whether the type-of-service field can be changed after the
TCP connection has been established depends on the implementation
in the underlying platform. Applications should not assume that
they can change the TOS field after the connection.
For Internet Protocol v6 tc is the value that
would be placed into the sin6_flowinfo field of the IP header. |
public void shutdownInput() throws IOException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!isConnected())
throw new SocketException("Socket is not connected");
if (isInputShutdown())
throw new SocketException("Socket input is already shutdown");
getImpl().shutdownInput();
shutIn = true;
}
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. |
public void shutdownOutput() throws IOException {
if (isClosed())
throw new SocketException("Socket is closed");
if (!isConnected())
throw new SocketException("Socket is not connected");
if (isOutputShutdown())
throw new SocketException("Socket output is already shutdown");
getImpl().shutdownOutput();
shutOut = true;
}
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. |
public String toString() {
try {
if (isConnected())
return "Socket[addr=" + getImpl().getInetAddress() +
",port=" + getImpl().getPort() +
",localport=" + getImpl().getLocalPort() + "]";
} catch (SocketException e) {
}
return "Socket[unconnected]";
}
Converts this socket to a String. |