internalclient

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(opts ...Opt) Client
  • func NewClientWithAsynq(uri string) Client
• type LeveledLogger
  • func (l *LeveledLogger) Debugf(msg string, keysAndValues ...interface{})
  • func (l *LeveledLogger) Errorf(msg string, keysAndValues ...interface{})
  • func (l *LeveledLogger) Warnf(msg string, keysAndValues ...interface{})
• type Opt
• type Options

Constants

const (
	DeviceUIDHeader = "X-Device-UID"
)

Variables

var (
	ErrConnectionFailed = errors.New("connection failed")
	ErrNotFound         = errors.New("not found")
	ErrUnknown          = errors.New("unknown error")
)

var (
	ErrFirewallConnection = errors.New("failed to make the request to evaluate the firewall")
	ErrFirewallBlock      = errors.New("a firewall rule prohibit this connection")
)

Types

type Client

type Client interface {
	// contains filtered or unexported methods
}

func NewClient

func NewClient(opts ...Opt) Client

func NewClientWithAsynq

func NewClientWithAsynq(uri string) Client

NewClientWithAsynq creates a new API internal client with the Asynq client injected to turn the API internal client able to enqueue ping tasks to the Asynq server and late process by API server.

It uses the NewClient function to create a new API internal client and injects the Asynq client to it through the Options structure.

type LeveledLogger

type LeveledLogger struct {
	Logger *logrus.Logger
}

func (*LeveledLogger) Debugf

func (l *LeveledLogger) Debugf(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Errorf

func (l *LeveledLogger) Errorf(msg string, keysAndValues ...interface{})

func (*LeveledLogger) Warnf

func (l *LeveledLogger) Warnf(msg string, keysAndValues ...interface{})

type Opt

type Opt func(*Options) error

type Options

type Options struct {
	Asynq *asynq.Client
}

Options wraps injectable values to a new API internal client. NOTE(r): This is a workaround to inject the Asynq client to the API internal client, because the [client] structure and its properties are privated.