rpcpool

Documentation

Index

• Variables
• type Conn
  • func New(opts Options, dial Dialer) *Conn
  • func (c *Conn) Close() (err error)
  • func (c *Conn) Invoke(ctx context.Context, rpc string, in drpc.Message, out drpc.Message) (err error)
  • func (c *Conn) NewStream(ctx context.Context, rpc string) (_ drpc.Stream, err error)
  • func (c *Conn) Put(conn *drpcconn.Conn) error
  • func (c *Conn) Transport() drpc.Transport
• type Dialer
• type Options

Variables

var Error = errs.Class("rpcpool")

Error is the class of errors returned by this package.

Types

type Conn

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

Conn implements drpc.Conn but keeps a pool of connections open.

func New

func New(opts Options, dial Dialer) *Conn

New returns a new Conn that will keep cap connections open using the provided dialer when it needs new ones.

func (*Conn) Close

func (c *Conn) Close() (err error)

Close closes all of the pool's connections and ensures no new ones will be made.

func (*Conn) Invoke

func (c *Conn) Invoke(ctx context.Context, rpc string, in drpc.Message, out drpc.Message) (err error)

Invoke implements drpc.Conn's Invoke method using a pooled connection.

func (*Conn) NewStream

func (c *Conn) NewStream(ctx context.Context, rpc string) (_ drpc.Stream, err error)

NewStream implements drpc.Conn's NewStream method using a pooled connection. It waits for the stream to be finished before replacing the connection into the pool.

func (*Conn) Put

func (c *Conn) Put(conn *drpcconn.Conn) error

Put places the connection back into the pool if there's room. It closes the connection if there is no room or the pool is closed. If the connection is closed, it does not attempt to place it into the pool.

func (*Conn) Transport

func (c *Conn) Transport() drpc.Transport

Transport returns nil because there is no well defined transport to use.

type Dialer

type Dialer = func(context.Context) (drpc.Transport, error)

Dialer is the type of function to create a new connection.

type Options

type Options struct {
	// Capacity is how many connections to keep open.
	Capacity int

	// IdleExpiration is how long a connection in the pool is allowed to be
	// kept idle. If zero, connections do not expire.
	IdleExpiration time.Duration
}

Options controls the options for a connection pool.