client

package

v1.10.4 Latest Latest Go to latest Published: May 1, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	UserAgentHeaderName = "user-agent"
)

This section is empty.

func GetIPAddr(ctx context.Context) (string, error)

GetIPAddr gets the client's IP address

func InjectLoggingMetadata(ctx context.Context, log *logrus.Entry) *logrus.Entry

InjectLoggingMetadata injects client metadata into a logrus log entry

func MinVersionStreamServerInterceptor() grpc.StreamServerInterceptor

MinVersionStreamServerInterceptor prevents versions below the minimum version from accessing lower version APIs.

func MinVersionUnaryServerInterceptor() grpc.UnaryServerInterceptor

MinVersionUnaryServerInterceptor prevents versions below the minimum version from accessing outdated APIs.

type DeviceType uint8

const (
	DeviceTypeUnknown DeviceType = iota
	DeviceTypeIOS
	DeviceTypeAndroid
)

func (t DeviceType) IsMobile() bool

func (t DeviceType) String() string

type UserAgent struct {
	DeviceType DeviceType
	Version    Version
}

func GetUserAgent(ctx context.Context) (*UserAgent, error)

GetUserAgent gets the Code client user agent value from headers in the provided context

func (ua *UserAgent) String() string

type Version struct {
	Major int
	Minor int
	Patch int
}

func ParseVersion(value string) (*Version, error)

func (v *Version) Before(other *Version) bool

func (v *Version) GreaterThanOrEqualTo(other *Version) bool

func (v *Version) String() string