Socket Option

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

api/v2/core/socket_option.proto

config.core.v3.SocketOption

[config.core.v3.SocketOption proto]

Generic socket option message. This would be used to set socket options that might not exist in upstream kernels or precompiled Envoy binaries.

{
  "description": "...",
  "level": "...",
  "name": "...",
  "int_value": "...",
  "buf_value": "...",
  "state": "..."
}

description

(string) An optional name to give this socket option for debugging, etc. Uniqueness is not required and no special meaning is assumed.

level

(int64) Corresponding to the level value passed to setsockopt, such as IPPROTO_TCP

name

(int64) The numeric name as passed to setsockopt

int_value

(int64) Because many sockopts take an int value.

Precisely one of int_value, buf_value must be set.

buf_value

(bytes) Otherwise it’s a byte buffer.

Precisely one of int_value, buf_value must be set.

state

(config.core.v3.SocketOption.SocketState) The state in which the option will be applied. When used in BindConfig STATE_PREBIND is currently the only valid value.

Enum config.core.v3.SocketOption.SocketState

[config.core.v3.SocketOption.SocketState proto]

STATE_PREBIND

(DEFAULT) ⁣Socket options are applied after socket creation but before binding the socket to a port

STATE_BOUND

⁣Socket options are applied after binding the socket to a port but before calling listen()

STATE_LISTENING

⁣Socket options are applied after calling listen()