client

Documentation

Overview

Package client implements a simple client for testing HotStuff. The client reads data from an input stream and sends the data in commands to a HotStuff replica. The client waits for replies from f+1 replicas before it considers a command to be executed.

Index

• type Client
  • func New(conf Config, builder modules.Builder) (client *Client)
  • func (c *Client) Connect(replicas []backend.ReplicaInfo) (err error)
  • func (c *Client) InitModule(mods *modules.Core)
  • func (c *Client) Run(ctx context.Context)
  • func (c *Client) Start()
  • func (c *Client) Stop()
• type Config
• type LatencyMeasurementEvent

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a hotstuff client.

func New

func New(conf Config, builder modules.Builder) (client *Client)

New returns a new Client.

func (*Client) Connect

func (c *Client) Connect(replicas []backend.ReplicaInfo) (err error)

Connect connects the client to the replicas.

func (*Client) InitModule

func (c *Client) InitModule(mods *modules.Core)

InitModule initializes the client.

func (*Client) Run

func (c *Client) Run(ctx context.Context)

Run runs the client until the context is closed.

func (*Client) Start

func (c *Client) Start()

Start starts the client.

func (*Client) Stop

func (c *Client) Stop()

Stop stops the client.

type Config

type Config struct {
	TLS              bool
	RootCAs          *x509.CertPool
	MaxConcurrent    uint32
	PayloadSize      uint32
	Input            io.ReadCloser
	ManagerOptions   []gorums.ManagerOption
	RateLimit        float64       // initial rate limit
	RateStep         float64       // rate limit step up
	RateStepInterval time.Duration // step up interval
	Timeout          time.Duration
}

Config contains config options for a client.

type LatencyMeasurementEvent

type LatencyMeasurementEvent struct {
	Latency time.Duration
}

LatencyMeasurementEvent represents a single latency measurement.