Package io.envoyproxy.envoy.extensions.filters.network.generic_proxy.codecs.http1.v3

Class Http1CodecConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.generic_proxy.codecs.http1.v3.Http1CodecConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Http1CodecConfigOrBuilder, Serializable
public final class Http1CodecConfig extends com.google.protobuf.GeneratedMessageV3 implements Http1CodecConfigOrBuilder
 Configuration for HTTP codec. This HTTP1 codec is used to parse and serialize HTTP1 messages
 for the generic proxy filter.
 Any decoding error will result in the generic proxy closing the connection.

 .. note::
   This codec only supports HTTP1.1 messages and does not support HTTP1.0 messages. And it limits
   part of the HTTP1.1 features, such as upgrade, connect, etc.
   This codec is mainly designed for the features evaluation of the generic proxy filter. Please
   be cautious when using it in production.
Protobuf type envoy.extensions.filters.network.generic_proxy.codecs.http1.v3.Http1CodecConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Http1CodecConfig.Builder
    Configuration for HTTP codec.

    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
    MAX_BUFFER_SIZE_FIELD_NUMBER
     
    static final int
    SINGLE_FRAME_MODE_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)
     
    static Http1CodecConfig
    getDefaultInstance()
     
    Http1CodecConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.UInt32Value
    getMaxBufferSize()
    The maximum size of the HTTP1 message body in bytes.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxBufferSizeOrBuilder()
    The maximum size of the HTTP1 message body in bytes.
    com.google.protobuf.Parser<Http1CodecConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.BoolValue
    getSingleFrameMode()
    If true, the codec will parse and serialize HTTP1 messages in a single frame per message.
    com.google.protobuf.BoolValueOrBuilder
    getSingleFrameModeOrBuilder()
    If true, the codec will parse and serialize HTTP1 messages in a single frame per message.
    int
    hashCode()
     
    boolean
    hasMaxBufferSize()
    The maximum size of the HTTP1 message body in bytes.
    boolean
    hasSingleFrameMode()
    If true, the codec will parse and serialize HTTP1 messages in a single frame per message.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Http1CodecConfig.Builder
    newBuilder()
     
    static Http1CodecConfig.Builder
    newBuilder(Http1CodecConfig prototype)
     
    Http1CodecConfig.Builder
    newBuilderForType()
     
    protected Http1CodecConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Http1CodecConfig
    parseDelimitedFrom(InputStream input)
     
    static Http1CodecConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Http1CodecConfig
    parseFrom(byte[] data)
     
    static Http1CodecConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Http1CodecConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static Http1CodecConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Http1CodecConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Http1CodecConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Http1CodecConfig
    parseFrom(InputStream input)
     
    static Http1CodecConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Http1CodecConfig
    parseFrom(ByteBuffer data)
     
    static Http1CodecConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Http1CodecConfig>
    parser()
     
    Http1CodecConfig.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

    • SINGLE_FRAME_MODE_FIELD_NUMBER

      public static final int SINGLE_FRAME_MODE_FIELD_NUMBER
      See Also:

    • MAX_BUFFER_SIZE_FIELD_NUMBER

      public static final int MAX_BUFFER_SIZE_FIELD_NUMBER
      See Also:

  • 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

    • hasSingleFrameMode

      public boolean hasSingleFrameMode()
       If true, the codec will parse and serialize HTTP1 messages in a single frame per message.

 A frame is a minimal unit of data that can be processed by the generic proxy. If false, the
 codec will parse and serialize HTTP1 messages in a streaming way. In this case, the codec
 will output multiple frames for a single HTTP1 message to the generic proxy.
 If true, the codec will buffer the entire HTTP1 message body before sending it to the generic
 proxy. This may have better performance in small message scenarios and is more friendly to
 handle the HTTP1 message body. This also may result in higher memory usage and latency if
 the message body is large.

 Default is true.
      .google.protobuf.BoolValue single_frame_mode = 1;
      Specified by:
      hasSingleFrameMode in interface Http1CodecConfigOrBuilder
      Returns:
      Whether the singleFrameMode field is set.

    • getSingleFrameMode

      public com.google.protobuf.BoolValue getSingleFrameMode()
       If true, the codec will parse and serialize HTTP1 messages in a single frame per message.

 A frame is a minimal unit of data that can be processed by the generic proxy. If false, the
 codec will parse and serialize HTTP1 messages in a streaming way. In this case, the codec
 will output multiple frames for a single HTTP1 message to the generic proxy.
 If true, the codec will buffer the entire HTTP1 message body before sending it to the generic
 proxy. This may have better performance in small message scenarios and is more friendly to
 handle the HTTP1 message body. This also may result in higher memory usage and latency if
 the message body is large.

 Default is true.
      .google.protobuf.BoolValue single_frame_mode = 1;
      Specified by:
      getSingleFrameMode in interface Http1CodecConfigOrBuilder
      Returns:
      The singleFrameMode.

    • getSingleFrameModeOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getSingleFrameModeOrBuilder()
       If true, the codec will parse and serialize HTTP1 messages in a single frame per message.

 A frame is a minimal unit of data that can be processed by the generic proxy. If false, the
 codec will parse and serialize HTTP1 messages in a streaming way. In this case, the codec
 will output multiple frames for a single HTTP1 message to the generic proxy.
 If true, the codec will buffer the entire HTTP1 message body before sending it to the generic
 proxy. This may have better performance in small message scenarios and is more friendly to
 handle the HTTP1 message body. This also may result in higher memory usage and latency if
 the message body is large.

 Default is true.
      .google.protobuf.BoolValue single_frame_mode = 1;
      Specified by:
      getSingleFrameModeOrBuilder in interface Http1CodecConfigOrBuilder

    • hasMaxBufferSize

      public boolean hasMaxBufferSize()
       The maximum size of the HTTP1 message body in bytes. If not set, 8*1024*1024 (8MB) is used.
 This only makes sense when single_frame_mode is true.
 If the HTTP1 message body size exceeds this value, this will result in a decoding error
 and the generic proxy will close the connection.
      .google.protobuf.UInt32Value max_buffer_size = 2;
      Specified by:
      hasMaxBufferSize in interface Http1CodecConfigOrBuilder
      Returns:
      Whether the maxBufferSize field is set.

    • getMaxBufferSize

      public com.google.protobuf.UInt32Value getMaxBufferSize()
       The maximum size of the HTTP1 message body in bytes. If not set, 8*1024*1024 (8MB) is used.
 This only makes sense when single_frame_mode is true.
 If the HTTP1 message body size exceeds this value, this will result in a decoding error
 and the generic proxy will close the connection.
      .google.protobuf.UInt32Value max_buffer_size = 2;
      Specified by:
      getMaxBufferSize in interface Http1CodecConfigOrBuilder
      Returns:
      The maxBufferSize.

    • getMaxBufferSizeOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxBufferSizeOrBuilder()
       The maximum size of the HTTP1 message body in bytes. If not set, 8*1024*1024 (8MB) is used.
 This only makes sense when single_frame_mode is true.
 If the HTTP1 message body size exceeds this value, this will result in a decoding error
 and the generic proxy will close the connection.
      .google.protobuf.UInt32Value max_buffer_size = 2;
      Specified by:
      getMaxBufferSizeOrBuilder in interface Http1CodecConfigOrBuilder

    • 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 Http1CodecConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Http1CodecConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Http1CodecConfig.Builder newBuilder()

    • newBuilder

      public static Http1CodecConfig.Builder newBuilder(Http1CodecConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Http1CodecConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Http1CodecConfig> 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 Http1CodecConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder