version

Documentation

Overview

Package version defines a mechanism for versioning the RPC protocol.

Index

• Variables
• func NewErrNoCompatibleVersion(ctx *context.T, lmin uint64, lmax uint64, rmin uint64, rmax uint64) error
• type RPCVersion
  • func CommonVersion(ctx *context.T, l, r RPCVersionRange) (RPCVersion, error)
• type RPCVersionRange

Variables

var (
	ErrNoCompatibleVersion = verror.Register("v.io/v23/rpc/version.NoCompatibleVersion", verror.NoRetry, "{1:}{2:} There were no compatible versions between ({3},{4}) and ({5},{6}).")
)

Functions

func NewErrNoCompatibleVersion

func NewErrNoCompatibleVersion(ctx *context.T, lmin uint64, lmax uint64, rmin uint64, rmax uint64) error

NewErrNoCompatibleVersion returns an error with the ErrNoCompatibleVersion ID.

Types

type RPCVersion

type RPCVersion uint32

RPCVersion represents a version of the RPC protocol.

const (
	// UnknownRPCVersion is used for Min/MaxRPCVersion in an Endpoint when
	// we don't know the relevant version numbers.  In this case the RPC
	// implementation will have to guess the correct values.
	UnknownRPCVersion RPCVersion = iota

	// DeprecatedRPCVersion is used to signal that a version number is no longer
	// relevant and that version information should be obtained elsewhere.
	DeprecatedRPCVersion

	// RPCVersion10 opens a special flow over which discharges for third-party
	// caveats on the server's blessings are sent.
	RPCVersion10

	// RPCVersion11 Optimized authentication.
	RPCVersion11

	// RPCVersion12 adds periodic healthchecks on the channel.
	RPCVersion12

	// RPCVersion13 adds error messages in responses from proxies.
	RPCVersion13

	// RPCVersion14 adds the setup message to the channel binding during
	// connection setup.
	RPCVersion14
)

func CommonVersion

func CommonVersion(ctx *context.T, l, r RPCVersionRange) (RPCVersion, error)

type RPCVersionRange

type RPCVersionRange struct {
	Min, Max RPCVersion
}

RPCVersionRange allows you to optionally specify a range of versions to use when calling FormatEndpoint