Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.http.config
Class SocketConfig

    java.lang.Object
      org.apache.http.config.SocketConfig

All Implemented Interfaces:
  Cloneable

    @Contract(threading=IMMUTABLE)
    public class SocketConfig

extends Object
implements Cloneable

Socket configuration.

Since:
  4.3

Nested Class Summary
`static class` | `SocketConfig.Builder`

Field Summary
`static SocketConfig` | `DEFAULT`

Method Summary
`protected SocketConfig` | `clone()`
`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.
`String` | `toString()`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### DEFAULT

    public static final SocketConfig DEFAULT

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: `false`

  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: `true`

  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

### clone

    protected SocketConfig clone()
                          throws CloneNotSupportedException

  Overrides:
    `clone` in class `Object`
  Throws:
    `CloneNotSupportedException`

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

### custom

    public static SocketConfig.Builder custom()

### copy

    public static SocketConfig.Builder copy(SocketConfig config)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.