Package org.apache.http.config

Class SocketConfig

  • All Implemented Interfaces:
    java.lang.Cloneable
    @Contract(threading=IMMUTABLE)
public class SocketConfig
extends java.lang.Object
implements java.lang.Cloneable
    Socket configuration.
    Since:
    4.3

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SocketConfig.Builder  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SocketConfig.Builder copy​(SocketConfig config)  
      static SocketConfig.Builder custom()  
      int getBacklogSize()
      Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog.
      int getRcvBufSize()
      Determines the default value of the SocketOptions.SO_RCVBUF parameter for newly created sockets.
      int getSndBufSize()
      Determines the default value of the SocketOptions.SO_SNDBUF parameter for newly created sockets.
      int getSoLinger()
      Determines the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.
      int getSoTimeout()
      Determines the default socket timeout value for non-blocking I/O operations.
      boolean isSoKeepAlive()
      Determines the default value of the SocketOptions.SO_KEEPALIVE parameter for newly created sockets.
      boolean isSoReuseAddress()
      Determines the default value of the SocketOptions.SO_REUSEADDR parameter for newly created sockets.
      boolean isTcpNoDelay()
      Determines the default value of the SocketOptions.TCP_NODELAY parameter for newly created sockets.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getSoTimeout

        public int getSoTimeout()
        Determines the default socket timeout value for non-blocking I/O operations.

        Default: 0 (no timeout)

        Returns:
        the default socket timeout value for non-blocking I/O operations.
        See Also:
        SocketOptions.SO_TIMEOUT

      • isSoReuseAddress

        public boolean isSoReuseAddress()
        Determines the default value of the SocketOptions.SO_REUSEADDR parameter for newly created sockets.

        Default: false

        Returns:
        the default value of the SocketOptions.SO_REUSEADDR parameter.
        See Also:
        SocketOptions.SO_REUSEADDR

      • getSoLinger

        public int getSoLinger()
        Determines the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.

        Default: -1

        Returns:
        the default value of the SocketOptions.SO_LINGER parameter.
        See Also:
        SocketOptions.SO_LINGER

      • isSoKeepAlive

        public boolean isSoKeepAlive()
        Determines the default value of the SocketOptions.SO_KEEPALIVE parameter for newly created sockets.

        Default: -1

        Returns:
        the default value of the SocketOptions.SO_KEEPALIVE parameter.
        See Also:
        SocketOptions.SO_KEEPALIVE

      • isTcpNoDelay

        public boolean isTcpNoDelay()
        Determines the default value of the SocketOptions.TCP_NODELAY parameter for newly created sockets.

        Default: false

        Returns:
        the default value of the SocketOptions.TCP_NODELAY parameter.
        See Also:
        SocketOptions.TCP_NODELAY

      • getSndBufSize

        public int getSndBufSize()
        Determines the default value of the SocketOptions.SO_SNDBUF parameter for newly created sockets.

        Default: 0 (system default)

        Returns:
        the default value of the SocketOptions.SO_SNDBUF parameter.
        Since:
        4.4
        See Also:
        SocketOptions.SO_SNDBUF

      • getRcvBufSize

        public int getRcvBufSize()
        Determines the default value of the SocketOptions.SO_RCVBUF parameter for newly created sockets.

        Default: 0 (system default)

        Returns:
        the default value of the SocketOptions.SO_RCVBUF parameter.
        Since:
        4.4
        See Also:
        SocketOptions.SO_RCVBUF

      • getBacklogSize

        public int getBacklogSize()
        Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog.

        Default: 0 (system default)

        Returns:
        the maximum queue length for incoming connection indications
        Since:
        4.4

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object