client

Documentation

Index

• Constants
• Variables
• type VersionChecker
  • func NewVersionChecker() VersionChecker

Constants

const (
	// GoSDK is the header value for common.ClientImplHeaderName indicating a go sdk client
	GoSDK = "uber-go"
	// JavaSDK is the header value for common.ClientImplHeaderName indicating a java sdk client
	JavaSDK = "uber-java"
	// CLI is the header value for common.ClientImplHeaderName indicating a cli client
	CLI = "cli"

	// SupportedGoSDKVersion indicates the highest go sdk version server will accept requests from
	SupportedGoSDKVersion = "1.6.0"
	// SupportedJavaSDKVersion indicates the highest java sdk version server will accept requests from
	SupportedJavaSDKVersion = "1.6.0"
	// SupportedCLIVersion indicates the highest cli version server will accept requests from
	SupportedCLIVersion = "1.6.0"

	// StickyQueryUnknownImplConstraints indicates the minimum client version of an unknown client type which supports StickyQuery
	StickyQueryUnknownImplConstraints = "1.0.0"
	// GoWorkerStickyQueryVersion indicates the minimum client version of go worker which supports StickyQuery
	GoWorkerStickyQueryVersion = "1.0.0"
	// JavaWorkerStickyQueryVersion indicates the minimum client version of the java worker which supports StickyQuery
	JavaWorkerStickyQueryVersion = "1.0.0"
	// GoWorkerConsistentQueryVersion indicates the minimum client version of the go worker which supports ConsistentQuery
	GoWorkerConsistentQueryVersion = "1.5.0"
	// JavaWorkerRawHistoryQueryVersion indicates the minimum client version of the java worker which supports RawHistoryQuery
	JavaWorkerRawHistoryQueryVersion = "1.3.0"
	// GoWorkerRawHistoryQueryVersion indicates the minimum client version of the go worker which supports RawHistoryQuery
	GoWorkerRawHistoryQueryVersion = "1.6.0"
	// CLIRawHistoryQueryVersion indicates the minimum CLI version of the go worker which supports RawHistoryQuery
	// Note: cli uses go client feature version
	CLIRawHistoryQueryVersion = "1.6.0"
)

Variables

var (
	// ErrUnknownFeature indicates that requested feature is not known by version checker
	ErrUnknownFeature = &shared.BadRequestError{Message: "Unknown feature"}
)

Types

type VersionChecker

type VersionChecker interface {
	ClientSupported(ctx context.Context, enableClientVersionCheck bool) error

	SupportsStickyQuery(clientImpl string, clientFeatureVersion string) error
	SupportsConsistentQuery(clientImpl string, clientFeatureVersion string) error
	SupportsRawHistoryQuery(clientImpl string, clientFeatureVersion string) error
}

VersionChecker is used to check client/server compatibility and client's capabilities

func NewVersionChecker

func NewVersionChecker() VersionChecker

NewVersionChecker constructs a new VersionChecker