Struct SocketOption

pub struct SocketOption {
    pub description: String,
    pub level: i64,
    pub name: i64,
    pub state: i32,
    pub value: Option<Value>,
}

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

For example:

.. code-block:: json

{ “description”: “support tcp keep alive”, “state”: 0, “level”: 1, “name”: 9, “int_value”: 1, }

1 means SOL_SOCKET and 9 means SO_KEEPALIVE on Linux. With the above configuration, TCP Keep-Alives <<https://www.freesoft.org/CIE/RFC/1122/114.htm>_> can be enabled in socket with Linux, which can be used in :ref:listener's<envoy_v3_api_field_config.listener.v3.Listener.socket_options> or :ref:admin's <envoy_v3_api_field_config.bootstrap.v3.Admin.socket_options> socket_options etc.

It should be noted that the name or level may have different values on different platforms. [#next-free-field: 7]

Fields

description: String

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

level: i64

Corresponding to the level value passed to setsockopt, such as IPPROTO_TCP

name: i64

The numeric name as passed to setsockopt

state: i32

The state in which the option will be applied. When used in BindConfig STATE_PREBIND is currently the only valid value.

value: Option<Value>

Implementations

impl SocketOption

pub fn state(&self) -> SocketState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: SocketState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for SocketOption

fn clone(&self) -> SocketOption

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocketOption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SocketOption

fn default() -> Self

Returns the “default value” for a type.

impl Message for SocketOption

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for SocketOption

const NAME: &'static str = "SocketOption"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.core.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for SocketOption

fn eq(&self, other: &SocketOption) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SocketOption