wsrpc

Documentation

Index

• Constants
• type Client
  • func NewClient(lggr logger.Logger, clientPrivKey csakey.KeyV2, serverPubKey []byte, ...) Client
• type Conn
• type Pool
  • func NewPool(lggr logger.Logger, cacheCfg cache.Config) Pool

Constants

const MaxConsecutiveTransmitFailures = 5

MaxConsecutiveTransmitFailures controls how many consecutive requests are allowed to time out before we reset the connection

Types

type Client

type Client interface {
	services.Service
	pb.MercuryClient
	ServerURL() string
	RawClient() pb.MercuryClient
}

func NewClient

func NewClient(lggr logger.Logger, clientPrivKey csakey.KeyV2, serverPubKey []byte, serverURL string, cacheSet cache.CacheSet) Client

Consumers of wsrpc package should not usually call NewClient directly, but instead use the Pool

type Conn

type Conn interface {
	WaitForReady(ctx context.Context) bool
	GetState() connectivity.State
	Close()
}

type Pool

type Pool interface {
	services.ServiceCtx
	// Checkout gets a wsrpc.Client for the given arguments
	// The same underlying client can be checked out multiple times, the pool
	// handles lifecycle management. The consumer can treat it as if it were
	// its own unique client.
	Checkout(ctx context.Context, clientPrivKey csakey.KeyV2, serverPubKey []byte, serverURL string) (client Client, err error)
}

func NewPool

func NewPool(lggr logger.Logger, cacheCfg cache.Config) Pool