client

Documentation

Index

• Variables
• type Client
  • func New(node peer.Node, path string) (*Client, error)
  • func (c *Client) Close()
  • func (c *Client) Context() context.Context
  • func (c *Client) New(cmd string, opts ...Option) *Request
  • func (c *Client) Send(cmd string, body command.Body) (cr.Response, error)
  • func (c *Client) SendTo(pid peerCore.ID, cmd string, body command.Body) (cr.Response, error)
  • func (c *Client) SendToWithTimeout(pid peerCore.ID, cmd string, body command.Body, timeout time.Duration) (cr.Response, error)
  • func (c *Client) SendWithTimeout(cmd string, body command.Body, timeout time.Duration) (cr.Response, error)
• type Option
  • func Body(body command.Body) Option
  • func Threshold(threshold int) Option
  • func Timeout(timeout time.Duration) Option
  • func To(peers ...peerCore.ID) Option
• type Request
  • func (r *Request) Do() (<-chan *Response, error)
• type Response
  • func (r *Response) Close()
  • func (r *Response) CloseRead()
  • func (r *Response) CloseWrite()
  • func (r *Response) Error() error
  • func (r *Response) PID() peerCore.ID

Variables

var (
	NumConnectTries   int           = 3
	NumStreamers      int           = 3
	DiscoveryLimit    int           = 1024
	SendToPeerTimeout time.Duration = 10 * time.Second

	MaxStreamsPerSend = 16
)

Types

type Client

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

func New

func New(node peer.Node, path string) (*Client, error)

func (*Client) Close

func (c *Client) Close()

func (*Client) Context

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

func (*Client) New

func (c *Client) New(cmd string, opts ...Option) *Request

func (*Client) Send

func (c *Client) Send(cmd string, body command.Body) (cr.Response, error)

func (*Client) SendTo

func (c *Client) SendTo(pid peerCore.ID, cmd string, body command.Body) (cr.Response, error)

func (*Client) SendToWithTimeout

func (c *Client) SendToWithTimeout(pid peerCore.ID, cmd string, body command.Body, timeout time.Duration) (cr.Response, error)

func (*Client) SendWithTimeout

func (c *Client) SendWithTimeout(cmd string, body command.Body, timeout time.Duration) (cr.Response, error)

type Option

type Option func(r *Request) error

func Body

func Body(body command.Body) Option

func Threshold

func Threshold(threshold int) Option

func Timeout

func Timeout(timeout time.Duration) Option

func To

func To(peers ...peerCore.ID) Option

type Request

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

func (*Request) Do

func (r *Request) Do() (<-chan *Response, error)

type Response

type Response struct {
	io.ReadWriter

	cr.Response
	// contains filtered or unexported fields
}

func (*Response) Close

func (r *Response) Close()

func (*Response) CloseRead

func (r *Response) CloseRead()

func (*Response) CloseWrite

func (r *Response) CloseWrite()

func (*Response) Error

func (r *Response) Error() error

func (*Response) PID

func (r *Response) PID() peerCore.ID