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

Class SocketOption

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.core.v3.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:

  • Nested Class Summary

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

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BUF_VALUE_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    INT_VALUE_FIELD_NUMBER
     
    static final int
    LEVEL_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.ByteString
    getBufValue()
    Otherwise it's a byte buffer.
    static SocketOption
    getDefaultInstance()
     
    SocketOption
    getDefaultInstanceForType()
     
    String
    getDescription()
    An optional name to give this socket option for debugging, etc.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    An optional name to give this socket option for debugging, etc.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getIntValue()
    Because many sockopts take an int value.
    long
    getLevel()
    Corresponding to the level value passed to setsockopt, such as IPPROTO_TCP
    long
    getName()
    The numeric name as passed to setsockopt
    com.google.protobuf.Parser<SocketOption>
    getParserForType()
     
    int
    getSerializedSize()
     
    SocketOption.SocketState
    getState()
    The state in which the option will be applied.
    int
    getStateValue()
    The state in which the option will be applied.
    SocketOption.ValueCase
    getValueCase()
     
    boolean
    hasBufValue()
    Otherwise it's a byte buffer.
    int
    hashCode()
     
    boolean
    hasIntValue()
    Because many sockopts take an int value.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SocketOption.Builder
    newBuilder()
     
    static SocketOption.Builder
    newBuilder(SocketOption prototype)
     
    SocketOption.Builder
    newBuilderForType()
     
    protected SocketOption.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SocketOption
    parseDelimitedFrom(InputStream input)
     
    static SocketOption
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SocketOption
    parseFrom(byte[] data)
     
    static SocketOption
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SocketOption
    parseFrom(com.google.protobuf.ByteString data)
     
    static SocketOption
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SocketOption
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SocketOption
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SocketOption
    parseFrom(InputStream input)
     
    static SocketOption
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SocketOption
    parseFrom(ByteBuffer data)
     
    static SocketOption
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SocketOption>
    parser()
     
    SocketOption.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getValueCase

      public SocketOption.ValueCase getValueCase()
      Specified by:
      getValueCase in interface SocketOptionOrBuilder

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SocketOption parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SocketOption parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static SocketOption.Builder newBuilder()

    • newBuilder

      public static SocketOption.Builder newBuilder(SocketOption prototype)

    • 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