client

Documentation

Index

• Constants
• func GetIPAddr(ctx context.Context) (string, error)
• func InjectLoggingMetadata(ctx context.Context, log *logrus.Entry) *logrus.Entry
• func MinVersionStreamServerInterceptor() grpc.StreamServerInterceptor
• func MinVersionUnaryServerInterceptor() grpc.UnaryServerInterceptor
• type DeviceType
  • func (t DeviceType) IsMobile() bool
  • func (t DeviceType) String() string
• type UserAgent
  • func GetUserAgent(ctx context.Context) (*UserAgent, error)
  • func (ua *UserAgent) String() string
• type Version
  • 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

Constants

const (
	UserAgentHeaderName = "user-agent"
)

Functions

func GetIPAddr

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

GetIPAddr gets the client's IP address

func InjectLoggingMetadata

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

InjectLoggingMetadata injects client metadata into a logrus log entry

func MinVersionStreamServerInterceptor

func MinVersionStreamServerInterceptor() grpc.StreamServerInterceptor

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

func MinVersionUnaryServerInterceptor

func MinVersionUnaryServerInterceptor() grpc.UnaryServerInterceptor

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

Types

type DeviceType

type DeviceType uint8

const (
	DeviceTypeUnknown DeviceType = iota
	DeviceTypeIOS
	DeviceTypeAndroid
)

func (DeviceType) IsMobile

func (t DeviceType) IsMobile() bool

func (DeviceType) String

func (t DeviceType) String() string

type UserAgent

type UserAgent struct {
	DeviceType DeviceType
	Version    Version
}

func GetUserAgent

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

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

func (*UserAgent) String

func (ua *UserAgent) String() string

type Version

type Version struct {
	Major int
	Minor int
	Patch int
}

func ParseVersion

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

func (*Version) Before

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

func (*Version) GreaterThanOrEqualTo

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

func (*Version) String

func (v *Version) String() string