Class UdpSocketConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UdpSocketConfigOrBuilder, Serializable

    public final class UdpSocketConfig
    extends com.google.protobuf.GeneratedMessageV3
    implements UdpSocketConfigOrBuilder
     Generic UDP socket configuration.
     
    Protobuf type envoy.config.core.v3.UdpSocketConfig
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UdpSocketConfig.Builder
      Generic UDP socket configuration.
      • 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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MAX_RX_DATAGRAM_SIZE_FIELD_NUMBER  
      static int PREFER_GRO_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
    • Field Detail

      • MAX_RX_DATAGRAM_SIZE_FIELD_NUMBER

        public static final int MAX_RX_DATAGRAM_SIZE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PREFER_GRO_FIELD_NUMBER

        public static final int PREFER_GRO_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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
      • hasMaxRxDatagramSize

        public boolean hasMaxRxDatagramSize()
         The maximum size of received UDP datagrams. Using a larger size will cause Envoy to allocate
         more memory per socket. Received datagrams above this size will be dropped. If not set
         defaults to 1500 bytes.
         
        .google.protobuf.UInt64Value max_rx_datagram_size = 1 [(.validate.rules) = { ... }
        Specified by:
        hasMaxRxDatagramSize in interface UdpSocketConfigOrBuilder
        Returns:
        Whether the maxRxDatagramSize field is set.
      • getMaxRxDatagramSize

        public com.google.protobuf.UInt64Value getMaxRxDatagramSize()
         The maximum size of received UDP datagrams. Using a larger size will cause Envoy to allocate
         more memory per socket. Received datagrams above this size will be dropped. If not set
         defaults to 1500 bytes.
         
        .google.protobuf.UInt64Value max_rx_datagram_size = 1 [(.validate.rules) = { ... }
        Specified by:
        getMaxRxDatagramSize in interface UdpSocketConfigOrBuilder
        Returns:
        The maxRxDatagramSize.
      • getMaxRxDatagramSizeOrBuilder

        public com.google.protobuf.UInt64ValueOrBuilder getMaxRxDatagramSizeOrBuilder()
         The maximum size of received UDP datagrams. Using a larger size will cause Envoy to allocate
         more memory per socket. Received datagrams above this size will be dropped. If not set
         defaults to 1500 bytes.
         
        .google.protobuf.UInt64Value max_rx_datagram_size = 1 [(.validate.rules) = { ... }
        Specified by:
        getMaxRxDatagramSizeOrBuilder in interface UdpSocketConfigOrBuilder
      • hasPreferGro

        public boolean hasPreferGro()
         Configures whether Generic Receive Offload (GRO)
         <https://en.wikipedia.org/wiki/Large_receive_offload>_ is preferred when reading from the
         UDP socket. The default is context dependent and is documented where UdpSocketConfig is used.
         This option affects performance but not functionality. If GRO is not supported by the operating
         system, non-GRO receive will be used.
         
        .google.protobuf.BoolValue prefer_gro = 2;
        Specified by:
        hasPreferGro in interface UdpSocketConfigOrBuilder
        Returns:
        Whether the preferGro field is set.
      • getPreferGro

        public com.google.protobuf.BoolValue getPreferGro()
         Configures whether Generic Receive Offload (GRO)
         <https://en.wikipedia.org/wiki/Large_receive_offload>_ is preferred when reading from the
         UDP socket. The default is context dependent and is documented where UdpSocketConfig is used.
         This option affects performance but not functionality. If GRO is not supported by the operating
         system, non-GRO receive will be used.
         
        .google.protobuf.BoolValue prefer_gro = 2;
        Specified by:
        getPreferGro in interface UdpSocketConfigOrBuilder
        Returns:
        The preferGro.
      • getPreferGroOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getPreferGroOrBuilder()
         Configures whether Generic Receive Offload (GRO)
         <https://en.wikipedia.org/wiki/Large_receive_offload>_ is preferred when reading from the
         UDP socket. The default is context dependent and is documented where UdpSocketConfig is used.
         This option affects performance but not functionality. If GRO is not supported by the operating
         system, non-GRO receive will be used.
         
        .google.protobuf.BoolValue prefer_gro = 2;
        Specified by:
        getPreferGroOrBuilder in interface UdpSocketConfigOrBuilder
      • 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 UdpSocketConfig parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static com.google.protobuf.Parser<UdpSocketConfig> parser()
      • getParserForType

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