synchronization

Documentation

Index

• Constants
• Variables
• type ConnectionStatus
• type ExplorerClient
  • func NewExplorerClient(url *url.URL, accessKey, secret string, statsPusherLogging bool, ...) ExplorerClient
• type NoopExplorerClient
  • func (NoopExplorerClient) Close() error
  • func (NoopExplorerClient) Healthy() error
  • func (NoopExplorerClient) Ready() error
  • func (NoopExplorerClient) Receive(context.Context, ...time.Duration) ([]byte, error)
  • func (NoopExplorerClient) Send(context.Context, []byte, ...int)
  • func (NoopExplorerClient) Start() error
  • func (NoopExplorerClient) Status() ConnectionStatus
  • func (NoopExplorerClient) Url() url.URL
• type NoopTelemetryIngressClient
  • func (NoopTelemetryIngressClient) Close() error
  • func (NoopTelemetryIngressClient) Healthy() error
  • func (NoopTelemetryIngressClient) Ready() error
  • func (NoopTelemetryIngressClient) Send(TelemPayload)
  • func (NoopTelemetryIngressClient) Start() error
• type TelemPayload
• type TelemetryIngressClient
  • func NewTelemetryIngressClient(url *url.URL, serverPubKeyHex string, ks keystore.CSA, logging bool, ...) TelemetryIngressClient

Constants

const (
	// ConnectionStatusDisconnected is the default state
	ConnectionStatusDisconnected = ConnectionStatus("disconnected")
	// ConnectionStatusConnected is used when the client is successfully connected
	ConnectionStatusConnected = ConnectionStatus("connected")
	// ConnectionStatusError is used when there is an error
	ConnectionStatusError = ConnectionStatus("error")
)

const (
	ExplorerTextMessage   = websocket.TextMessage
	ExplorerBinaryMessage = websocket.BinaryMessage
)

const CloseTimeout = 100 * time.Millisecond

const SendBufferSize = 100

SendBufferSize is the number of messages to keep in the buffer before dropping additional ones

const SendIngressBufferSize = 100

SendIngressBufferSize is the number of messages to keep in the buffer before dropping additional ones

Variables

var (
	// ErrReceiveTimeout is returned when no message is received after a
	// specified duration in Receive
	ErrReceiveTimeout = errors.New("timeout waiting for message")
)

Types

type ConnectionStatus

type ConnectionStatus string

type ExplorerClient

type ExplorerClient interface {
	service.Service
	Url() url.URL
	Status() ConnectionStatus
	Send(context.Context, []byte, ...int)
	Receive(context.Context, ...time.Duration) ([]byte, error)
}

ExplorerClient encapsulates all the functionality needed to push run information to explorer.

func NewExplorerClient

func NewExplorerClient(url *url.URL, accessKey, secret string, statsPusherLogging bool, lggr logger.Logger) ExplorerClient

NewExplorerClient returns a stats pusher using a websocket for delivery.

type NoopExplorerClient

type NoopExplorerClient struct{}

func (NoopExplorerClient) Close

func (NoopExplorerClient) Close() error

func (NoopExplorerClient) Healthy

func (NoopExplorerClient) Healthy() error

func (NoopExplorerClient) Ready

func (NoopExplorerClient) Ready() error

func (NoopExplorerClient) Receive

func (NoopExplorerClient) Receive(context.Context, ...time.Duration) ([]byte, error)

func (NoopExplorerClient) Send

func (NoopExplorerClient) Send(context.Context, []byte, ...int)

func (NoopExplorerClient) Start

func (NoopExplorerClient) Start() error

func (NoopExplorerClient) Status

func (NoopExplorerClient) Status() ConnectionStatus

func (NoopExplorerClient) Url

func (NoopExplorerClient) Url() url.URL

type NoopTelemetryIngressClient

type NoopTelemetryIngressClient struct{}

func (NoopTelemetryIngressClient) Close

func (NoopTelemetryIngressClient) Close() error

func (NoopTelemetryIngressClient) Healthy

func (NoopTelemetryIngressClient) Healthy() error

func (NoopTelemetryIngressClient) Ready

func (NoopTelemetryIngressClient) Ready() error

func (NoopTelemetryIngressClient) Send

func (NoopTelemetryIngressClient) Send(TelemPayload)

func (NoopTelemetryIngressClient) Start

func (NoopTelemetryIngressClient) Start() error

type TelemPayload

type TelemPayload struct {
	Ctx             context.Context
	Telemetry       []byte
	ContractAddress common.Address
}

type TelemetryIngressClient

type TelemetryIngressClient interface {
	service.Service
	Start() error
	Close() error
	Send(TelemPayload)
}

TelemetryIngressClient encapsulates all the functionality needed to send telemetry to the ingress server using wsrpc

func NewTelemetryIngressClient

func NewTelemetryIngressClient(url *url.URL, serverPubKeyHex string, ks keystore.CSA, logging bool, lggr logger.Logger) TelemetryIngressClient

NewTelemetryIngressClient returns a client backed by wsrpc that can send telemetry to the telemetry ingress server