Constructor Summary

Method Summary

Constructor Details

• Socket

  public Socket()

  Creates an unconnected Socket.

  If the application has specified a client socket implementation factory, that factory'screateSocketImpl method is called to create the actual socket implementation. Otherwise a system-default socket implementation is created.

  Since:

  1.1

• Socket

  public Socket(Proxy 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, itscheckConnect 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 - aProxy object specifying what kind of proxying should be used.

  Throws:

  IllegalArgumentException - if the proxy is of an invalid type ornull.

  SecurityException - if a security manager is present and permission to connect to the proxy is denied.

  Since:

  1.5

  See Also:

  • ProxySelector
  • Proxy

• Socket

  protected Socket(SocketImpl impl) throwsSocketException

  Creates an unconnected Socket with a user-specified SocketImpl.

  Parameters:

  impl - an instance of aSocketImpl the subclass wishes to use on the Socket.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  SecurityException - ifimpl is non-null and a security manager is set and itscheckPermission method doesn't allowNetPermission("setSocketImpl").

  Since:

  1.1

• Socket

  public Socket(String host, int port) throwsUnknownHostException,IOException

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

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

  If the application has specified a client socket implementation factory, that factory'screateSocketImpl method is called to create the actual socket implementation. Otherwise a system-default socket implementation is created.

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

  Parameters:

  host - the host name, ornull 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 itscheckConnect 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.

  See Also:

  • SocketImpl
  • SecurityManager.checkConnect(java.lang.String, int)

• Socket

  public Socket(InetAddress address, int port) throwsIOException

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

  If the application has specified a client socket implementation factory, that factory'screateSocketImpl method is called to create the actual socket implementation. Otherwise a system-default socket implementation is created.

  If there is a security manager, itscheckConnect method is called with the host address andport 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 itscheckConnect 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 - ifaddress is null.

  See Also:

  • SocketImpl
  • SecurityManager.checkConnect(java.lang.String, int)

• Socket

  public Socket(String host, int port,InetAddress localAddr, int localPort) throwsIOException

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

  A local port number ofzero will let the system pick up a free port in thebind operation.

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

  Parameters:

  host - the name of the remote host, ornull for the loopback address.

  port - the remote port

  localAddr - the local address the socket is bound to, ornull for theanyLocal address.

  localPort - the local port the socket is bound to, orzero 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 itscheckConnect method doesn't allow the connection to the destination, or if itscheckListen method doesn't allow the bind to the local port.

  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:

  1.1

  See Also:

  • SecurityManager.checkConnect(java.lang.String, int)

• Socket

  public Socket(InetAddress address, int port,InetAddress localAddr, int localPort) throwsIOException

  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 isnull it is the equivalent of specifying the address as the AnyLocal address (seeInetAddress.isAnyLocalAddress()).

  A local port number ofzero will let the system pick up a free port in thebind operation.

  If there is a security manager, itscheckConnect method is called with the host address andport 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, ornull for theanyLocal address.

  localPort - the local port the socket is bound to orzero 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 itscheckConnect method doesn't allow the connection to the destination, or if itscheckListen method doesn't allow the bind to the local port.

  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 - ifaddress is null.

  Since:

  1.1

  See Also:

  • SecurityManager.checkConnect(java.lang.String, int)

• Socket

  @Deprecatedpublic Socket(String host, int port, boolean stream) throwsIOException

  Deprecated.

  Use DatagramSocket instead for UDP transport.

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

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

  If the stream argument istrue, this creates a stream socket. If the stream argument isfalse, it creates a datagram socket.

  If the application has specified a client socket implementation factory, that factory'screateSocketImpl method is called to create the actual socket implementation. Otherwise a system-default socket implementation is created.

  If there is a security manager, itscheckConnect method is called with the host address andport 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, ornull for the loopback address.

  port - the port number.

  stream - aboolean 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 itscheckConnect 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.

  See Also:

  • SocketImpl
  • SecurityManager.checkConnect(java.lang.String, int)

• Socket

  @Deprecatedpublic Socket(InetAddress host, int port, boolean stream) throwsIOException

  Deprecated.

  Use DatagramSocket instead for UDP transport.

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

  If the stream argument istrue, this creates a stream socket. If the stream argument isfalse, it creates a datagram socket.

  If the application has specified a client socket implementation factory, that factory'screateSocketImpl method is called to create the actual socket implementation. Otherwise a system-default socket implementation is created.

  If there is a security manager, itscheckConnect method is called withhost.getHostAddress() andport 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 - iftrue, 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 itscheckConnect 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 - ifhost is null.

  See Also:

  • SocketImpl
  • SecurityManager.checkConnect(java.lang.String, int)

Method Details

• connect

  public void connect(SocketAddress endpoint) throwsIOException

  Connects this socket to the server.

  This method isinterruptible in the following circumstances:

  1. The socket isassociated with aSocketChannel. In that case, interrupting a thread establishing a connection will close the underlying channel and cause this method to throwClosedByInterruptException with the interrupt status set.
  2. The socket uses the system-default socket implementation and avirtual thread is establishing a connection. In that case, interrupting the virtual thread will cause it to wakeup and close the socket. This method will then throwSocketException with the interrupt status set.

  Parameters:

  endpoint - theSocketAddress

  Throws:

  IOException - if an error occurs during the connection

  IllegalBlockingModeException - if this socket has an associated channel, and the channel is in non-blocking mode

  IllegalArgumentException - if endpoint is null or is a SocketAddress subclass not supported by this socket

  Since:

  1.4

• connect

  public void connect(SocketAddress endpoint, int timeout) throwsIOException

  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.

  This method isinterruptible in the following circumstances:

  1. The socket isassociated with aSocketChannel. In that case, interrupting a thread establishing a connection will close the underlying channel and cause this method to throwClosedByInterruptException with the interrupt status set.
  2. The socket uses the system-default socket implementation and avirtual thread is establishing a connection. In that case, interrupting the virtual thread will cause it to wakeup and close the socket. This method will then throwSocketException with the interrupt status set.

  Parameters:

  endpoint - theSocketAddress

  timeout - the timeout value to be used in milliseconds.

  Throws:

  IOException - if an error occurs during the connection

  SocketTimeoutException - if timeout expires before connecting

  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, or iftimeout is negative

  Since:

  1.4

• bind

  public void bind(SocketAddress bindpoint) throwsIOException

  Binds the socket to a local address.

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

  Parameters:

  bindpoint - theSocketAddress to bind to

  Throws:

  IOException - if the bind operation fails, or if the socket is already bound.

  IllegalArgumentException - if bindpoint is a SocketAddress subclass not supported by this socket

  SecurityException - if a security manager exists and itscheckListen method doesn't allow the bind to the local port.

  Since:

  1.4

  See Also:

  • isBound(int)

• getInetAddress

  public InetAddress getInetAddress()

  Returns the address to which the socket is connected.

  If the socket was connected prior to beingclosed, then this method will continue to return the connected address after the socket is closed.

  Returns:

  the remote IP address to which this socket is connected, ornull if the socket is not connected.

• getLocalAddress

  public InetAddress getLocalAddress()

  Gets the local address to which the socket is bound.

  If there is a security manager set, itscheckConnect method is called with the local address and-1 as its arguments to see if the operation is allowed. If the operation is not allowed, theloopback address is returned.

  Returns:

  the local address to which the socket is bound, the loopback address if denied by the security manager, or the wildcard address if the socket is closed or not bound yet.

  Since:

  1.1

  See Also:

  • SecurityManager.checkConnect(java.lang.String, int)

• getPort

  public int getPort()

  Returns the remote port number to which this socket is connected.

  If the socket was connected prior to beingclosed, then this method will continue to return the connected port number after the socket is closed.

  Returns:

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

• getLocalPort

  public int getLocalPort()

  Returns the local port number to which this socket is bound.

  If the socket was bound prior to beingclosed, then this method will continue to return the local port number after the socket is closed.

  Returns:

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

• getRemoteSocketAddress

  public SocketAddress getRemoteSocketAddress()

  Returns the address of the endpoint this socket is connected to, ornull if it is unconnected.

  If the socket was connected prior to beingclosed, then this method will continue to return the connected address after the socket is closed.

  Returns:

  aSocketAddress representing the remote endpoint of this socket, ornull if it is not connected yet.

  Since:

  1.4

  See Also:

  • getInetAddress()
  • getPort()
  • connect(SocketAddress, int)
  • connect(SocketAddress)

• getLocalSocketAddress

  public SocketAddress getLocalSocketAddress()

  Returns the address of the endpoint this socket is bound to.

  If a socket bound to an endpoint represented by anInetSocketAddress isclosed, then this method will continue to return anInetSocketAddress after the socket is closed. In that case the returnedInetSocketAddress's address is thewildcard address and its port is the local port that it was bound to.

  If there is a security manager set, itscheckConnect method is called with the local address and-1 as its arguments to see if the operation is allowed. If the operation is not allowed, aSocketAddress representing theloopback address and the local port to which this socket is bound is returned.

  Returns:

  aSocketAddress representing the local endpoint of this socket, or aSocketAddress representing the loopback address if denied by the security manager, ornull if the socket is not bound yet.

  Since:

  1.4

  See Also:

  • getLocalAddress()
  • getLocalPort()
  • bind(SocketAddress)
  • SecurityManager.checkConnect(java.lang.String, int)

• getChannel

  public SocketChannel getChannel()

  Returns the uniqueSocketChannel object associated with this socket, if any.

  A socket will have a channel if, and only if, the channel itself was created via theSocketChannel.open orServerSocketChannel.accept methods.

  Returns:

  the socket channel associated with this socket, ornull if this socket was not created for a channel

  Since:

  1.4

• getInputStream

  public InputStream getInputStream() throwsIOException

  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'sread operations will throw anIllegalBlockingModeException.

  Reading from the input stream isinterruptible in the following circumstances:

  1. The socket isassociated with aSocketChannel. In that case, interrupting a thread reading from the input stream will close the underlying channel and cause the read method to throwClosedByInterruptException with the interrupt status set.
  2. The socket uses the system-default socket implementation and avirtual thread is reading from the input stream. In that case, interrupting the virtual thread will cause it to wakeup and close the socket. The read method will then throwSocketException with the interrupt status set.

  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 usingread.

  • If there are no bytes buffered on the socket, or all buffered bytes have been consumed byread, then all subsequent calls toread will throw anIOException.

  • If there are no bytes buffered on the socket, and the socket has not been closed usingclose, thenavailable will return0.

  Closing the returnedInputStream will close the associated socket.

  Returns:

  an input stream for reading bytes from this socket.

  Throws:

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

• getOutputStream

  public OutputStream getOutputStream() throwsIOException

  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'swrite operations will throw anIllegalBlockingModeException.

  Writing to the output stream isinterruptible in the following circumstances:

  1. The socket isassociated with aSocketChannel. In that case, interrupting a thread writing to the output stream will close the underlying channel and cause the write method to throwClosedByInterruptException with the interrupt status set.
  2. The socket uses the system-default socket implementation and avirtual thread is writing to the output stream. In that case, interrupting the virtual thread will cause it to wakeup and close the socket. The write method will then throwSocketException with the interrupt status set.

  Closing the returnedOutputStream will close the associated socket.

  Returns:

  an output stream for writing bytes to this socket.

  Throws:

  IOException - if an I/O error occurs when creating the output stream or if the socket is not connected.

• setTcpNoDelay

  public void setTcpNoDelay(boolean on) throwsSocketException

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

  Parameters:

  on -true to enable TCP_NODELAY,false to disable.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.1

  See Also:

  • getTcpNoDelay()

• getTcpNoDelay

  public boolean getTcpNoDelay() throwsSocketException

  Tests ifTCP_NODELAY is enabled.

  Returns:

  aboolean indicating whether or notTCP_NODELAY is enabled.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.1

  See Also:

  • setTcpNoDelay(boolean)

• setSoLinger

  public void setSoLinger(boolean on, int linger) throwsSocketException

  Enable/disableSO_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.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  IllegalArgumentException - if the linger value is negative.

  Since:

  1.1

  See Also:

  • getSoLinger()

• getSoLinger

  public int getSoLinger() throwsSocketException

  Returns setting forSO_LINGER. -1 returns implies that the option is disabled. The setting only affects socket close.

  Returns:

  the setting forSO_LINGER.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.1

  See Also:

  • setSoLinger(boolean, int)

• sendUrgentData

  public void sendUrgentData(int data) throwsIOException

  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

  Throws:

  IOException - if there is an error sending the data.

  Since:

  1.4

• setOOBInline

  public void setOOBInline(boolean on) throwsSocketException

  Enable/disableSO_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 enableSO_OOBINLINE,false to disable.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.4

  See Also:

  • getOOBInline()

• getOOBInline

  public boolean getOOBInline() throwsSocketException

  Tests ifSO_OOBINLINE is enabled.

  Returns:

  aboolean indicating whether or notSO_OOBINLINE is enabled.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.4

  See Also:

  • setOOBInline(boolean)

• setSoTimeout

  public void setSoTimeout(int timeout) throwsSocketException

  Enable/disableSO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a positive timeout value, a read() call on the InputStream associated with this Socket will block for only this amount of time. If the timeout expires, ajava.net.SocketTimeoutException is raised, though the Socket is still valid. A timeout of zero is interpreted as an infinite timeout. The optionmust be enabled prior to entering the blocking operation to have effect.

  Parameters:

  timeout - the specified timeout, in milliseconds.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error

  IllegalArgumentException - iftimeout is negative

  Since:

  1.1

  See Also:

  • getSoTimeout()

• getSoTimeout

  public int getSoTimeout() throwsSocketException

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

  Returns:

  the setting forSO_TIMEOUT

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.1

  See Also:

  • setSoTimeout(int)

• setSendBufferSize

  public void setSendBufferSize(int size) throwsSocketException

  Sets theSO_SNDBUF option to the specified value for thisSocket. TheSO_SNDBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.

  BecauseSO_SNDBUF is a hint, applications that want to verify what size the buffers were set to should callgetSendBufferSize().

  Parameters:

  size - the size to which to set the send buffer size. This value must be greater than 0.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  IllegalArgumentException - if the value is 0 or is negative.

  Since:

  1.2

  See Also:

  • getSendBufferSize()

• getSendBufferSize

  public int getSendBufferSize() throwsSocketException

  Get value of theSO_SNDBUF option for thisSocket, that is the buffer size used by the platform for output on thisSocket.

  Returns:

  the value of theSO_SNDBUF option for thisSocket.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.2

  See Also:

  • setSendBufferSize(int)

• setReceiveBufferSize

  public void setReceiveBufferSize(int size) throwsSocketException

  Sets theSO_RCVBUF option to the specified value for thisSocket. TheSO_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.

  BecauseSO_RCVBUF is a hint, applications that want to verify what size the buffers were set to should callgetReceiveBufferSize().

  The value ofSO_RCVBUF is also used to set the TCP receive window that is advertised 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 requestedbefore 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 callingServerSocket.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.

  Throws:

  IllegalArgumentException - if the value is 0 or is negative.

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.2

  See Also:

  • getReceiveBufferSize()
  • ServerSocket.setReceiveBufferSize(int)

• getReceiveBufferSize

  public int getReceiveBufferSize() throwsSocketException

  Gets the value of theSO_RCVBUF option for thisSocket, that is the buffer size used by the platform for input on thisSocket.

  Returns:

  the value of theSO_RCVBUF option for thisSocket.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.2

  See Also:

  • setReceiveBufferSize(int)

• setKeepAlive

  public void setKeepAlive(boolean on) throwsSocketException

  Enable/disableSO_KEEPALIVE.

  Parameters:

  on - whether or not to have socket keep alive turned on.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.3

  See Also:

  • getKeepAlive()

• getKeepAlive

  public boolean getKeepAlive() throwsSocketException

  Tests ifSO_KEEPALIVE is enabled.

  Returns:

  aboolean indicating whether or notSO_KEEPALIVE is enabled.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.3

  See Also:

  • setKeepAlive(boolean)

• setTrafficClass

  public void setTrafficClass(int tc) throwsSocketException

  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 tcmust be in the range0 <= tc <= 255 or an IllegalArgumentException will be thrown.

  Notes:

  For Internet Protocol v4 the value consists of aninteger, 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 v6tc is the value that would be placed into the sin6_flowinfo field of the IP header.

  Parameters:

  tc - anint value for the bitset.

  Throws:

  SocketException - if there is an error setting the traffic class or type-of-service

  Since:

  1.4

  See Also:

  • getTrafficClass()
  • SocketOptions.IP_TOS

• getTrafficClass

  public int getTrafficClass() throwsSocketException

  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 usingsetTrafficClass(int) this method may return a different value than was previously set using thesetTrafficClass(int) method on this Socket.

  Returns:

  the traffic class or type-of-service already set

  Throws:

  SocketException - if there is an error obtaining the traffic class or type-of-service value.

  Since:

  1.4

  See Also:

  • setTrafficClass(int)
  • SocketOptions.IP_TOS

• setReuseAddress

  public void setReuseAddress(boolean on) throwsSocketException

  Enable/disable theSO_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 theTIME_WAIT state or2MSL wait state). For applications using a well known socket address or port it may not be possible to bind a socket to the requiredSocketAddress if there is a connection in the timeout state involving the socket address or port.

  EnablingSO_REUSEADDR prior to binding the socket usingbind(SocketAddress) allows the socket to be bound even though a previous connection is in a timeout state.

  When aSocket is created the initial setting ofSO_REUSEADDR is disabled.

  The behaviour whenSO_REUSEADDR is enabled or disabled after a socket is bound (SeeisBound()) is not defined.

  Parameters:

  on - whether to enable or disable the socket option

  Throws:

  SocketException - if an error occurs enabling or disabling theSO_REUSEADDR socket option, or the socket is closed.

  Since:

  1.4

  See Also:

  • getReuseAddress()
  • bind(SocketAddress)
  • isClosed()
  • isBound()

• getReuseAddress

  public boolean getReuseAddress() throwsSocketException

  Tests ifSO_REUSEADDR is enabled.

  Returns:

  aboolean indicating whether or notSO_REUSEADDR is enabled.

  Throws:

  SocketException - if there is an error in the underlying protocol, such as a TCP error.

  Since:

  1.4

  See Also:

  • setReuseAddress(boolean)

• close

  public void close() throwsIOException

  Closes this socket.

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

  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'sInputStream andOutputStream.

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

  Specified by:

  close in interface AutoCloseable

  Specified by:

  close in interface Closeable

  Throws:

  IOException - if an I/O error occurs when closing this socket.

  See Also:

  • isClosed(int)

• shutdownInput

  public void shutdownInput() throwsIOException

  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 this method on the socket, the stream'savailable method will return 0, and itsread methods will return-1 (end of stream).

  Throws:

  IOException - if an I/O error occurs when shutting down this socket.

  Since:

  1.3

  See Also:

  • shutdownOutput()
  • close()
  • setSoLinger(boolean, int)
  • isInputShutdown(int)

• shutdownOutput

  public void shutdownOutput() throwsIOException

  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.

  Throws:

  IOException - if an I/O error occurs when shutting down this socket.

  Since:

  1.3

  See Also:

  • shutdownInput()
  • close()
  • setSoLinger(boolean, int)
  • isOutputShutdown(int)

• toString

  public String toString()

  Converts this socket to aString.

  Overrides:

  toString in class Object

  Returns:

  a string representation of this socket.

• isConnected

  public boolean isConnected()

  Returns the connection state of the socket.

  Note: Closing a socket doesn't clear its connection state, which means this method will returntrue for a closed socket (seeisClosed()) if it was successfully connected prior to being closed.

  Returns:

  true if the socket was successfully connected to a server

  Since:

  1.4

• isBound

  public boolean isBound()

  Returns the binding state of the socket.

  Note: Closing a socket doesn't clear its binding state, which means this method will returntrue for a closed socket (seeisClosed()) if it was successfully bound prior to being closed.

  Returns:

  true if the socket was successfully bound to an address

  Since:

  1.4

  See Also:

  • bind(java.net.SocketAddress)

• isClosed

  public boolean isClosed()

  Returns the closed state of the socket.

  Returns:

  true if the socket has been closed

  Since:

  1.4

  See Also:

  • close()

• isInputShutdown

  public boolean isInputShutdown()

  Returns whether the read-half of the socket connection is closed.

  Returns:

  true if the input of the socket has been shutdown

  Since:

  1.4

  See Also:

  • shutdownInput()

• isOutputShutdown

  public boolean isOutputShutdown()

  Returns whether the write-half of the socket connection is closed.

  Returns:

  true if the output of the socket has been shutdown

  Since:

  1.4

  See Also:

  • shutdownOutput()

• setSocketImplFactory

  @Deprecated(since="17")public static void setSocketImplFactory(SocketImplFactory fac) throwsIOException

  Deprecated.

  Use aSocketFactory and subclassSocket directly.
  This method provided a way in early JDK releases to replace the system wide implementation ofSocket. It has been mostly obsolete since Java 1.4. If required, aSocket can be created to use a custom implementation by extendingSocket and using theprotected constructor that takes animplementation as a parameter.

  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'screateSocketImpl method is called to create the actual socket implementation.

  Passingnull 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'scheckSetFactory method to ensure the operation is allowed. This could result in a SecurityException.

  Parameters:

  fac - the desired factory.

  Throws:

  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 itscheckSetFactory method doesn't allow the operation.

  See Also:

  • SocketImplFactory.createSocketImpl()
  • SecurityManager.checkSetFactory()

• setPerformancePreferences

  public void setPerformancePreferences(int connectionTime, int latency, int bandwidth)

  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.

  Parameters:

  connectionTime - Anint expressing the relative importance of a short connection time

  latency - Anint expressing the relative importance of low latency

  bandwidth - Anint expressing the relative importance of high bandwidth

  Since:

  1.5

• setOption

  public <T> Socket setOption(SocketOption<T> name, T value) throwsIOException

  Sets the value of a socket option.

  Type Parameters:

  T - The type of the socket option value

  Parameters:

  name - The socket option

  value - The value of the socket option. A value ofnull may be valid for some options.

  Returns:

  this Socket

  Throws:

  UnsupportedOperationException - if the socket does not support the option.

  IllegalArgumentException - if the value is not valid for the option.

  IOException - if an I/O error occurs, or if the socket is closed.

  NullPointerException - if name isnull

  SecurityException - if a security manager is set and if the socket option requires a security permission and if the caller does not have the required permission.StandardSocketOptions do not require any security permission.

  Since:

  9

• getOption

  public <T> T getOption(SocketOption<T> name) throwsIOException

  Returns the value of a socket option.

  Type Parameters:

  T - The type of the socket option value

  Parameters:

  name - The socket option

  Returns:

  The value of the socket option.

  Throws:

  UnsupportedOperationException - if the socket does not support the option.

  IOException - if an I/O error occurs, or if the socket is closed.

  NullPointerException - if name isnull

  SecurityException - if a security manager is set and if the socket option requires a security permission and if the caller does not have the required permission.StandardSocketOptions do not require any security permission.

  Since:

  9

• supportedOptions

  public Set<SocketOption<?>> supportedOptions()

  Returns a set of the socket options supported by this socket. This method will continue to return the set of options even after the socket has been closed.

  Returns:

  A set of the socket options supported by this socket. This set may be empty if the socket's SocketImpl cannot be created.

  Since:

  9