Package io.envoyproxy.envoy.config.core.v3

Class SocketOption

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SocketOptionOrBuilder, Serializable
    public final class SocketOption
extends com.google.protobuf.GeneratedMessageV3
implements SocketOptionOrBuilder
     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]
    Protobuf type envoy.config.core.v3.SocketOption
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SocketOption.Builder
      Generic socket option message.
      static class  SocketOption.SocketState
      Protobuf enum envoy.config.core.v3.SocketOption.SocketState
      static class  SocketOption.ValueCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getDescription

        public String getDescription()
         An optional name to give this socket option for debugging, etc.
 Uniqueness is not required and no special meaning is assumed.
        string description = 1;
        Specified by:
        getDescription in interface SocketOptionOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional name to give this socket option for debugging, etc.
 Uniqueness is not required and no special meaning is assumed.
        string description = 1;
        Specified by:
        getDescriptionBytes in interface SocketOptionOrBuilder
        Returns:
        The bytes for description.

      • getLevel

        public long getLevel()
         Corresponding to the level value passed to setsockopt, such as IPPROTO_TCP
        int64 level = 2;
        Specified by:
        getLevel in interface SocketOptionOrBuilder
        Returns:
        The level.

      • getName

        public long getName()
         The numeric name as passed to setsockopt
        int64 name = 3;
        Specified by:
        getName in interface SocketOptionOrBuilder
        Returns:
        The name.

      • hasIntValue

        public boolean hasIntValue()
         Because many sockopts take an int value.
        int64 int_value = 4;
        Specified by:
        hasIntValue in interface SocketOptionOrBuilder
        Returns:
        Whether the intValue field is set.

      • getIntValue

        public long getIntValue()
         Because many sockopts take an int value.
        int64 int_value = 4;
        Specified by:
        getIntValue in interface SocketOptionOrBuilder
        Returns:
        The intValue.

      • hasBufValue

        public boolean hasBufValue()
         Otherwise it's a byte buffer.
        bytes buf_value = 5;
        Specified by:
        hasBufValue in interface SocketOptionOrBuilder
        Returns:
        Whether the bufValue field is set.

      • getBufValue

        public com.google.protobuf.ByteString getBufValue()
         Otherwise it's a byte buffer.
        bytes buf_value = 5;
        Specified by:
        getBufValue in interface SocketOptionOrBuilder
        Returns:
        The bufValue.

      • getStateValue

        public int getStateValue()
         The state in which the option will be applied. When used in BindConfig
 STATE_PREBIND is currently the only valid value.
        .envoy.config.core.v3.SocketOption.SocketState state = 6 [(.validate.rules) = { ... }
        Specified by:
        getStateValue in interface SocketOptionOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public SocketOption.SocketState getState()
         The state in which the option will be applied. When used in BindConfig
 STATE_PREBIND is currently the only valid value.
        .envoy.config.core.v3.SocketOption.SocketState state = 6 [(.validate.rules) = { ... }
        Specified by:
        getState in interface SocketOptionOrBuilder
        Returns:
        The state.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SocketOption parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SocketOption parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SocketOption.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public SocketOption.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected SocketOption.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static SocketOption getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<SocketOption> parser()

      • getParserForType

        public com.google.protobuf.Parser<SocketOption> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SocketOption getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder