transport

Documentation

Overview

Package transport defines the interface that describe the functionality required to communicate with an xDS server using streaming calls.

Index

• type BuildOptions
• type Builder
• type StreamingCall
• type Transport

Types

type BuildOptions

type BuildOptions struct {
	// ServerConfig contains the configuration that controls how the transport
	// interacts with the xDS server. This includes the server URI and the
	// credentials to use to connect to the server, among other things.
	ServerConfig *bootstrap.ServerConfig
}

BuildOptions contains the options for building a new xDS transport.

type Builder

type Builder interface {
	// Build creates a new xDS transport with the provided options.
	Build(opts BuildOptions) (Transport, error)
}

Builder is an interface for building a new xDS transport.

type StreamingCall

type StreamingCall interface {
	// Send sends the provided message on the stream.
	Send(any) error

	// Recv block until the next message is received on the stream.
	Recv() (any, error)
}

StreamingCall is an interface that provides a way to send and receive messages on a stream. The methods accept or return any.Any messages instead of concrete types to allow this interface to be used for both ADS and LRS.

type Transport

type Transport interface {
	// CreateStreamingCall creates a new streaming call to the xDS server for the
	// specified method name. The returned StreamingCall interface can be used to
	// send and receive messages on the stream.
	CreateStreamingCall(context.Context, string) (StreamingCall, error)

	// Close closes the underlying connection and cleans up any resources used by the
	// Transport.
	Close() error
}

Transport provides the functionality to communicate with an xDS server using streaming calls.