client

Documentation

Index

• Constants
• Variables
• type Client
• type Commander
  • func NewCommanderClient() Commander
• type Controller
  • func NewClientController() Controller
• type Message
  • func MessageFromCommand(cmd *proto.Command) Message
  • func MessageFromEvents(event *models.EventReport) Message
  • func MessageFromMetrics(metric *proto.MetricsReport) Message
• type MetricReporter
  • func NewMetricReporterClient() MetricReporter
• type MsgClassification
• type MsgType

Constants

const (
	DefaultChunkSize = 4 * 1024
)

Variables

var (
	ErrDownloadHeaderUnexpectedNumber = &backoff.PermanentError{Err: status.Error(codes.DataLoss, "unexpected number of headers")}
	ErrDownloadChecksumMismatch       = &backoff.PermanentError{Err: status.Error(codes.DataLoss, "download checksum mismatch")}
	ErrDownloadDataChunkNoData        = &backoff.PermanentError{Err: status.Error(codes.DataLoss, "download DataChunk without data")}
	ErrUnmarshallingData              = &backoff.PermanentError{Err: status.Error(codes.DataLoss, "unable to unmarshal data")}
)

var DefaultBackoffSettings = backoff.BackoffSettings{
	InitialInterval: 100 * time.Millisecond,
	MaxInterval:     1 * time.Minute,
	MaxElapsedTime:  0,
	Jitter:          backoff.BACKOFF_JITTER,
	Multiplier:      backoff.BACKOFF_MULTIPLIER,
}

Types

type Client

type Client interface {
	Connect(ctx context.Context) error
	Close() error

	Server() string
	WithServer(string) Client

	DialOptions() []grpc.DialOption
	WithDialOptions(options ...grpc.DialOption) Client

	WithInterceptor(interceptor interceptors.Interceptor) Client
	WithClientInterceptor(interceptor interceptors.ClientInterceptor) Client

	WithBackoffSettings(backoffSettings backoff.BackoffSettings) Client
}

type Commander

type Commander interface {
	Client
	ChunksSize() int
	WithChunkSize(int) Client
	Send(context.Context, Message) error
	Download(context.Context, *proto.Metadata) (*proto.NginxConfig, error)
	Upload(context.Context, *proto.NginxConfig, string) error
	Recv() <-chan Message
}

func NewCommanderClient

func NewCommanderClient() Commander

type Controller

type Controller interface {
	WithClient(Client) Controller
	Context() context.Context
	WithContext(context.Context) Controller
	Connect() error
	Close() error
}

func NewClientController

func NewClientController() Controller

type Message

type Message interface {
	Meta() *proto.Metadata
	Type() MsgType
	Classification() MsgClassification
	Data() interface{}
	Raw() interface{}
}

func MessageFromCommand

func MessageFromCommand(cmd *proto.Command) Message

func MessageFromEvents

func MessageFromEvents(event *models.EventReport) Message

func MessageFromMetrics

func MessageFromMetrics(metric *proto.MetricsReport) Message

type MetricReporter

type MetricReporter interface {
	Client
	Send(context.Context, Message) error
}

func NewMetricReporterClient

func NewMetricReporterClient() MetricReporter

type MsgClassification

type MsgClassification int

const (
	MsgClassificationCommand MsgClassification = iota
	MsgClassificationMetric
	MsgClassificationEvent
)

type MsgType

type MsgType interface {
	String() string
	EnumDescriptor() ([]byte, []int)
}