types

Documentation

Index

• type MarshaledResource
• type Resource
• type ResourceWithName
• type ResourceWithTTL
• type ResponseType
• type SkipFetchError
  • func (e SkipFetchError) Error() string

Types

type MarshaledResource

type MarshaledResource = []byte

MarshaledResource is an alias for the serialized binary array.

type Resource

type Resource interface {
	proto.Message
}

Resource is the base interface for the xDS payload.

type ResourceWithName

type ResourceWithName interface {
	proto.Message
	GetName() string
}

ResourceWithName provides a name for out-of-tree resources.

type ResourceWithTTL

type ResourceWithTTL struct {
	Resource Resource
	TTL      *time.Duration
}

ResourceWithTTL is a Resource with an optional TTL.

type ResponseType

type ResponseType int

ResponseType enumeration of supported response types

const (
	Endpoint ResponseType = iota
	Cluster
	ScopedRoute
	Route
	VirtualHost
	Listener
	Secret
	Runtime
	ExtensionConfig
	RateLimitConfig
	UnknownType // token to count the total number of supported types
)

NOTE: The order of this enum MATTERS! https://www.envoyproxy.io/docs/envoy/latest/api-docs/xds_protocol#aggregated-discovery-service ADS expects things to be returned in a specific order. See the following issue for details: https://github.com/envoyproxy/go-control-plane/issues/526

type SkipFetchError

type SkipFetchError struct{}

SkipFetchError is the error returned when the cache fetch is short circuited due to the client's version already being up-to-date.

func (SkipFetchError) Error

func (e SkipFetchError) Error() string

Error satisfies the error interface