package tcpv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/upstreams/tcp/v3"

Index ¶

• Variables
• type TcpProtocolOptions
• func (*TcpProtocolOptions) Descriptor() ([]byte, []int)
• func (x *TcpProtocolOptions) GetIdleTimeout() *durationpb.Duration
• func (*TcpProtocolOptions) ProtoMessage()
• func (x *TcpProtocolOptions) ProtoReflect() protoreflect.Message
• func (x *TcpProtocolOptions) Reset()
• func (x *TcpProtocolOptions) String() string
• func (m *TcpProtocolOptions) Validate() error
• func (m *TcpProtocolOptions) ValidateAll() error
• type TcpProtocolOptionsMultiError
• func (m TcpProtocolOptionsMultiError) AllErrors() []error
• func (m TcpProtocolOptionsMultiError) Error() string
• type TcpProtocolOptionsValidationError
• func (e TcpProtocolOptionsValidationError) Cause() error
• func (e TcpProtocolOptionsValidationError) Error() string
• func (e TcpProtocolOptionsValidationError) ErrorName() string
• func (e TcpProtocolOptionsValidationError) Field() string
• func (e TcpProtocolOptionsValidationError) Key() bool
• func (e TcpProtocolOptionsValidationError) Reason() string

Variables ¶

var File_envoy_extensions_upstreams_tcp_v3_tcp_protocol_options_proto protoreflect.FileDescriptor

Types ¶

type TcpProtocolOptions ¶

type TcpProtocolOptions struct {

	// The idle timeout for the connection. The idle timeout is defined as the period in which
	// the connection is not associated with a downstream connection. When the idle timeout is
	// reached, the connection will be closed.
	//
	// If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.
	//
	// .. warning::
	//
	//	Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
	//	FIN packets, etc.
	IdleTimeout *durationpb.Duration `protobuf:"bytes,1,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// contains filtered or unexported fields
}

func (*TcpProtocolOptions) Descriptor ¶

func (*TcpProtocolOptions) Descriptor() ([]byte, []int)

Deprecated: Use TcpProtocolOptions.ProtoReflect.Descriptor instead.

func (*TcpProtocolOptions) GetIdleTimeout ¶

func (x *TcpProtocolOptions) GetIdleTimeout() *durationpb.Duration

func (*TcpProtocolOptions) ProtoMessage ¶

func (*TcpProtocolOptions) ProtoMessage()

func (*TcpProtocolOptions) ProtoReflect ¶

func (x *TcpProtocolOptions) ProtoReflect() protoreflect.Message

func (*TcpProtocolOptions) Reset ¶

func (x *TcpProtocolOptions) Reset()

func (*TcpProtocolOptions) String ¶

func (x *TcpProtocolOptions) String() string

func (*TcpProtocolOptions) Validate ¶

func (m *TcpProtocolOptions) Validate() error

Validate checks the field values on TcpProtocolOptions with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*TcpProtocolOptions) ValidateAll ¶

func (m *TcpProtocolOptions) ValidateAll() error

ValidateAll checks the field values on TcpProtocolOptions with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TcpProtocolOptionsMultiError, or nil if none found.

type TcpProtocolOptionsMultiError ¶

type TcpProtocolOptionsMultiError []error

TcpProtocolOptionsMultiError is an error wrapping multiple validation errors returned by TcpProtocolOptions.ValidateAll() if the designated constraints aren't met.

func (TcpProtocolOptionsMultiError) AllErrors ¶

func (m TcpProtocolOptionsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TcpProtocolOptionsMultiError) Error ¶

func (m TcpProtocolOptionsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TcpProtocolOptionsValidationError ¶

type TcpProtocolOptionsValidationError struct {
	// contains filtered or unexported fields
}

TcpProtocolOptionsValidationError is the validation error returned by TcpProtocolOptions.Validate if the designated constraints aren't met.

func (TcpProtocolOptionsValidationError) Cause ¶

func (e TcpProtocolOptionsValidationError) Cause() error

Cause function returns cause value.

func (TcpProtocolOptionsValidationError) Error ¶

func (e TcpProtocolOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (TcpProtocolOptionsValidationError) ErrorName ¶

func (e TcpProtocolOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (TcpProtocolOptionsValidationError) Field ¶

func (e TcpProtocolOptionsValidationError) Field() string

Field function returns field value.

func (TcpProtocolOptionsValidationError) Key ¶

func (e TcpProtocolOptionsValidationError) Key() bool

Key function returns key value.

func (TcpProtocolOptionsValidationError) Reason ¶

func (e TcpProtocolOptionsValidationError) Reason() string

Reason function returns reason value.

Source Files ¶

tcp_protocol_options.pb.go tcp_protocol_options.pb.validate.go