envoy_extensions_filters_udp_udp_proxy_v3

package
v0.9.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 21, 2021 License: Apache-2.0 Imports: 20 Imported by: 17

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_filters_udp_udp_proxy_v3_udp_proxy_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type UdpProxyConfig 

type UdpProxyConfig struct {

	// The stat prefix used when emitting UDP proxy filter stats.
	StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Types that are assignable to RouteSpecifier:
	//	*UdpProxyConfig_Cluster
	RouteSpecifier isUdpProxyConfig_RouteSpecifier `protobuf_oneof:"route_specifier"`
	// The idle timeout for sessions. Idle is defined as no datagrams between received or sent by
	// the session. The default if not specified is 1 minute.
	IdleTimeout *duration.Duration `protobuf:"bytes,3,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Use the remote downstream IP address as the sender IP address when sending packets to upstream hosts.
	// This option requires Envoy to be run with the *CAP_NET_ADMIN* capability on Linux.
	// And the IPv6 stack must be enabled on Linux kernel.
	// This option does not preserve the remote downstream port.
	// If this option is enabled, the IP address of sent datagrams will be changed to the remote downstream IP address.
	// This means that Envoy will not receive packets that are sent by upstream hosts because the upstream hosts
	// will send the packets with the remote downstream IP address as the destination. All packets will be routed
	// to the remote downstream directly if there are route rules on the upstream host side.
	// There are two options to return the packets back to the remote downstream.
	// The first one is to use DSR (Direct Server Return).
	// The other one is to configure routing rules on the upstream hosts to forward
	// all packets back to Envoy and configure iptables rules on the host running Envoy to
	// forward all packets from upstream hosts to the Envoy process so that Envoy can forward the packets to the downstream.
	// If the platform does not support this option, Envoy will raise a configuration error.
	UseOriginalSrcIp bool `protobuf:"varint,4,opt,name=use_original_src_ip,json=useOriginalSrcIp,proto3" json:"use_original_src_ip,omitempty"`
	// Optional configuration for UDP proxy hash policies. If hash_policies is not set, the hash-based
	// load balancing algorithms will select a host randomly. Currently the number of hash policies is
	// limited to 1.
	HashPolicies []*UdpProxyConfig_HashPolicy `protobuf:"bytes,5,rep,name=hash_policies,json=hashPolicies,proto3" json:"hash_policies,omitempty"`
	// UDP socket configuration for upstream sockets. The default for
	// :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is true for upstream
	// sockets as the assumption is datagrams will be received from a single source.
	UpstreamSocketConfig *v3.UdpSocketConfig `protobuf:"bytes,6,opt,name=upstream_socket_config,json=upstreamSocketConfig,proto3" json:"upstream_socket_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the UDP proxy filter. [#next-free-field: 7]

func (*UdpProxyConfig) Descriptor deprecated 

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

Deprecated: Use UdpProxyConfig.ProtoReflect.Descriptor instead.

func (*UdpProxyConfig) GetCluster 

func (x *UdpProxyConfig) GetCluster() string

func (*UdpProxyConfig) GetHashPolicies added in v0.9.7 

func (x *UdpProxyConfig) GetHashPolicies() []*UdpProxyConfig_HashPolicy

func (*UdpProxyConfig) GetIdleTimeout 

func (x *UdpProxyConfig) GetIdleTimeout() *duration.Duration

func (*UdpProxyConfig) GetRouteSpecifier 

func (m *UdpProxyConfig) GetRouteSpecifier() isUdpProxyConfig_RouteSpecifier

func (*UdpProxyConfig) GetStatPrefix 

func (x *UdpProxyConfig) GetStatPrefix() string

func (*UdpProxyConfig) GetUpstreamSocketConfig added in v0.9.9 

func (x *UdpProxyConfig) GetUpstreamSocketConfig() *v3.UdpSocketConfig

func (*UdpProxyConfig) GetUseOriginalSrcIp added in v0.9.7 

func (x *UdpProxyConfig) GetUseOriginalSrcIp() bool

func (*UdpProxyConfig) ProtoMessage 

func (*UdpProxyConfig) ProtoMessage()

func (*UdpProxyConfig) ProtoReflect 

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

func (*UdpProxyConfig) Reset 

func (x *UdpProxyConfig) Reset()

func (*UdpProxyConfig) String 

func (x *UdpProxyConfig) String() string

func (*UdpProxyConfig) Validate 

func (m *UdpProxyConfig) Validate() error

Validate checks the field values on UdpProxyConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type UdpProxyConfigValidationError 

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

UdpProxyConfigValidationError is the validation error returned by UdpProxyConfig.Validate if the designated constraints aren't met.

func (UdpProxyConfigValidationError) Cause 

func (e UdpProxyConfigValidationError) Cause() error

Cause function returns cause value.

func (UdpProxyConfigValidationError) Error 

func (e UdpProxyConfigValidationError) Error() string

Error satisfies the builtin error interface

func (UdpProxyConfigValidationError) ErrorName 

func (e UdpProxyConfigValidationError) ErrorName() string

ErrorName returns error name.

func (UdpProxyConfigValidationError) Field 

func (e UdpProxyConfigValidationError) Field() string

Field function returns field value.

func (UdpProxyConfigValidationError) Key 

func (e UdpProxyConfigValidationError) Key() bool

Key function returns key value.

func (UdpProxyConfigValidationError) Reason 

func (e UdpProxyConfigValidationError) Reason() string

Reason function returns reason value.

type UdpProxyConfig_Cluster 

type UdpProxyConfig_Cluster struct {
	// The upstream cluster to connect to.
	Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3,oneof"`
}

type UdpProxyConfig_HashPolicy added in v0.9.7 

type UdpProxyConfig_HashPolicy struct {

	// Types that are assignable to PolicySpecifier:
	//	*UdpProxyConfig_HashPolicy_SourceIp
	//	*UdpProxyConfig_HashPolicy_Key
	PolicySpecifier isUdpProxyConfig_HashPolicy_PolicySpecifier `protobuf_oneof:"policy_specifier"`
	// contains filtered or unexported fields
}

Specifies the UDP hash policy. The packets can be routed by hash policy.

func (*UdpProxyConfig_HashPolicy) Descriptor deprecated added in v0.9.7 

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

Deprecated: Use UdpProxyConfig_HashPolicy.ProtoReflect.Descriptor instead.

func (*UdpProxyConfig_HashPolicy) GetKey added in v0.9.9 

func (x *UdpProxyConfig_HashPolicy) GetKey() string

func (*UdpProxyConfig_HashPolicy) GetPolicySpecifier added in v0.9.7 

func (m *UdpProxyConfig_HashPolicy) GetPolicySpecifier() isUdpProxyConfig_HashPolicy_PolicySpecifier

func (*UdpProxyConfig_HashPolicy) GetSourceIp added in v0.9.7 

func (x *UdpProxyConfig_HashPolicy) GetSourceIp() bool

func (*UdpProxyConfig_HashPolicy) ProtoMessage added in v0.9.7 

func (*UdpProxyConfig_HashPolicy) ProtoMessage()

func (*UdpProxyConfig_HashPolicy) ProtoReflect added in v0.9.7 

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

func (*UdpProxyConfig_HashPolicy) Reset added in v0.9.7 

func (x *UdpProxyConfig_HashPolicy) Reset()

func (*UdpProxyConfig_HashPolicy) String added in v0.9.7 

func (x *UdpProxyConfig_HashPolicy) String() string

func (*UdpProxyConfig_HashPolicy) Validate added in v0.9.7 

func (m *UdpProxyConfig_HashPolicy) Validate() error

Validate checks the field values on UdpProxyConfig_HashPolicy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type UdpProxyConfig_HashPolicyValidationError added in v0.9.7 

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

UdpProxyConfig_HashPolicyValidationError is the validation error returned by UdpProxyConfig_HashPolicy.Validate if the designated constraints aren't met.

func (UdpProxyConfig_HashPolicyValidationError) Cause added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) Cause() error

Cause function returns cause value.

func (UdpProxyConfig_HashPolicyValidationError) Error added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) Error() string

Error satisfies the builtin error interface

func (UdpProxyConfig_HashPolicyValidationError) ErrorName added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (UdpProxyConfig_HashPolicyValidationError) Field added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) Field() string

Field function returns field value.

func (UdpProxyConfig_HashPolicyValidationError) Key added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) Key() bool

Key function returns key value.

func (UdpProxyConfig_HashPolicyValidationError) Reason added in v0.9.7 

func (e UdpProxyConfig_HashPolicyValidationError) Reason() string

Reason function returns reason value.

type UdpProxyConfig_HashPolicy_Key added in v0.9.9 

type UdpProxyConfig_HashPolicy_Key struct {
	// A given key will be used to compute the hash used by hash-based load balancing algorithms.
	// In certain cases there is a need to direct different UDP streams jointly towards the selected set of endpoints.
	// A possible use-case is VoIP telephony, where media (RTP) and its corresponding control (RTCP) belong to the same logical session,
	// although they travel in separate streams. To ensure that these pair of streams are load-balanced on session level
	// (instead of individual stream level), dynamically created listeners can use the same hash key for each stream in the session.
	Key string `protobuf:"bytes,2,opt,name=key,proto3,oneof"`
}

type UdpProxyConfig_HashPolicy_SourceIp added in v0.9.7 

type UdpProxyConfig_HashPolicy_SourceIp struct {
	// The source IP will be used to compute the hash used by hash-based load balancing algorithms.
	SourceIp bool `protobuf:"varint,1,opt,name=source_ip,json=sourceIp,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.