tcp

Documentation

Index

• Variables
• type Client
  • func NewClient(logger logrus.FieldLogger, pool ConnPool) *Client
  • func (client *Client) Run(ctx context.Context, messages protocol.MessageReceiver)
• type ConnPool
  • func NewConnPool(options ConnPoolOptions, logger logrus.FieldLogger, ...) ConnPool
• type ConnPoolOptions
• type Server
  • func NewServer(options ServerOptions, logger logrus.FieldLogger, ...) *Server
  • func (server *Server) Run(ctx context.Context, messages protocol.MessageSender)
• type ServerOptions

Variables

var ErrTooManyConnections = errors.New("too many connections")

ErrTooManyConnections is returned the current number of connections exceeds the limit.

Types

type Client

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

func NewClient

func NewClient(logger logrus.FieldLogger, pool ConnPool) *Client

func (*Client) Run

func (client *Client) Run(ctx context.Context, messages protocol.MessageReceiver)

type ConnPool

type ConnPool interface {
	Send(net.Addr, protocol.Message) error
}

A ConnPool maintains multiple connections to different remote peers and re-uses these connections when sending multiple message to the peer. If a connection to a peer does not exist when a message is sent, then it is established. When there are multiple Clients, they should all use a shared ConnPool, and therefore all implementations must be safe for concurrent use.

func NewConnPool

func NewConnPool(options ConnPoolOptions, logger logrus.FieldLogger, handshaker handshake.Handshaker) ConnPool

NewConnPool returns a ConnPool with no existing connections. It is safe for concurrent use.

type ConnPoolOptions

type ConnPoolOptions struct {
	Timeout        time.Duration // Timeout when dialing new connections.
	TimeToLive     time.Duration // Time-to-live for connections.
	MaxConnections int           // Max connections allowed.
}

ConnPoolOptions are used to parameterise the behaviour of a ConnPool.

type Server

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

func NewServer

func NewServer(options ServerOptions, logger logrus.FieldLogger, handshaker handshake.Handshaker) *Server

func (*Server) Run

func (server *Server) Run(ctx context.Context, messages protocol.MessageSender)

Run the server until the context is done. The server will continuously listen for new connections, spawning each one into a background goroutine so that it can be handled concurrently.

type ServerOptions

type ServerOptions struct {
	Host           string        // Host address
	Timeout        time.Duration // Timeout when establish a connection
	RateLimit      time.Duration // Minimum time interval before accepting connection from same peer.
	MaxConnections int           // Max connections allowed.
}