client

Documentation

Index

• Constants
• func DefaultHTTPClient(remoteAddr string) (*http.Client, error)
• func HTTPClientForTest(remoteAddr string) (*http.Client, error)
• func MaxReconnectAttempts(max int) func(*WSClient)
• func OnReconnect(cb func()) func(*WSClient)
• func PingPeriod(pingPeriod time.Duration) func(*WSClient)
• func ReadWait(readWait time.Duration) func(*WSClient)
• func WriteWait(writeWait time.Duration) func(*WSClient)
• type Caller
• type Client
  • func New(remote string) (*Client, error)
  • func NewWithHTTPClient(remote string, client *http.Client) (*Client, error)
  • func (c *Client) Call(ctx context.Context, method string, params map[string]interface{}, ...) (interface{}, error)
  • func (c *Client) NewRequestBatch() *RequestBatch
• type HTTPClient
• type RequestBatch
  • func (b *RequestBatch) Call(_ context.Context, method string, params map[string]interface{}, ...) (interface{}, error)
  • func (b *RequestBatch) Clear() int
  • func (b *RequestBatch) Count() int
  • func (b *RequestBatch) Send(ctx context.Context) ([]interface{}, error)
• type URIClient
  • func NewURI(remote string) (*URIClient, error)
  • func (c *URIClient) Call(ctx context.Context, method string, params map[string]interface{}, ...) (interface{}, error)
• type WSClient
  • func NewWS(remoteAddr, endpoint string, options ...func(*WSClient)) (*WSClient, error)
  • func (c *WSClient) Call(ctx context.Context, method string, params map[string]interface{}) error
  • func (c *WSClient) CallWithArrayParams(ctx context.Context, method string, params []interface{}) error
  • func (c *WSClient) IsActive() bool
  • func (c *WSClient) IsReconnecting() bool
  • func (c *WSClient) OnStart() error
  • func (c *WSClient) Send(ctx context.Context, request types.RPCRequest) error
  • func (c *WSClient) Stop() error
  • func (c *WSClient) String() string
  • func (c *WSClient) Subscribe(ctx context.Context, query string) error
  • func (c *WSClient) Unsubscribe(ctx context.Context, query string) error
  • func (c *WSClient) UnsubscribeAll(ctx context.Context) error

Constants

const (
	// URIClientRequestID in a request ID used by URIClient
	URIClientRequestID = types.JSONRPCIntID(-1)
)

Functions

func DefaultHTTPClient

func DefaultHTTPClient(remoteAddr string) (*http.Client, error)

DefaultHTTPClient is used to create an http client with some default parameters. We overwrite the http.Client.Dial so we can do http over tcp or unix. remoteAddr should be fully featured (eg. with tcp:// or unix://). An error will be returned in case of invalid remoteAddr.

func HTTPClientForTest

func HTTPClientForTest(remoteAddr string) (*http.Client, error)

HTTPClientForTest set short second on Transport.IdleConnTimeout See: DefaultHTTPClient

: Transport.IdleConnTimeout:       defaultIdleConnTimeout * time.Second

func MaxReconnectAttempts

func MaxReconnectAttempts(max int) func(*WSClient)

MaxReconnectAttempts sets the maximum number of reconnect attempts before returning an error. It should only be used in the constructor and is not Goroutine-safe.

func OnReconnect

func OnReconnect(cb func()) func(*WSClient)

OnReconnect sets the callback, which will be called every time after successful reconnect.

func PingPeriod

func PingPeriod(pingPeriod time.Duration) func(*WSClient)

PingPeriod sets the duration for sending websocket pings. It should only be used in the constructor - not Goroutine-safe.

func ReadWait

func ReadWait(readWait time.Duration) func(*WSClient)

ReadWait sets the amount of time to wait before a websocket read times out. It should only be used in the constructor and is not Goroutine-safe.

func WriteWait

func WriteWait(writeWait time.Duration) func(*WSClient)

WriteWait sets the amount of time to wait before a websocket write times out. It should only be used in the constructor and is not Goroutine-safe.

Types

type Caller

type Caller interface {
	Call(ctx context.Context, method string, params map[string]interface{}, result interface{}) (interface{}, error)
}

Caller implementers can facilitate calling the JSON-RPC endpoint.

type Client

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

Client is a JSON-RPC client, which sends POST HTTP requests to the remote server.

Client is safe for concurrent use by multiple goroutines.

func New

func New(remote string) (*Client, error)

New returns a Client pointed at the given address. An error is returned on invalid remote. The function panics when remote is nil.

func NewWithHTTPClient

func NewWithHTTPClient(remote string, client *http.Client) (*Client, error)

NewWithHTTPClient returns a Client pointed at the given address using a custom http client. An error is returned on invalid remote. The function panics when remote is nil.

func (*Client) Call

func (c *Client) Call(
	ctx context.Context,
	method string,
	params map[string]interface{},
	result interface{},
) (interface{}, error)

Call issues a POST HTTP request. Requests are JSON encoded. Content-Type: application/json.

func (*Client) NewRequestBatch

func (c *Client) NewRequestBatch() *RequestBatch

NewRequestBatch starts a batch of requests for this client.

type HTTPClient

type HTTPClient interface {
	// Call calls the given method with the params and returns a result.
	Call(ctx context.Context, method string, params map[string]interface{}, result interface{}) (interface{}, error)
}

HTTPClient is a common interface for JSON-RPC HTTP clients.

type RequestBatch

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

RequestBatch allows us to buffer multiple request/response structures into a single batch request. Note that this batch acts like a FIFO queue, and is thread-safe.

func (*RequestBatch) Call

func (b *RequestBatch) Call(
	_ context.Context,
	method string,
	params map[string]interface{},
	result interface{},
) (interface{}, error)

Call enqueues a request to call the given RPC method with the specified parameters, in the same way that the `Client.Call` function would.

func (*RequestBatch) Clear

func (b *RequestBatch) Clear() int

Clear empties out the request batch.

func (*RequestBatch) Count

func (b *RequestBatch) Count() int

Count returns the number of enqueued requests waiting to be sent.

func (*RequestBatch) Send

func (b *RequestBatch) Send(ctx context.Context) ([]interface{}, error)

Send will attempt to send the current batch of enqueued requests, and then will clear out the requests once done. On success, this returns the deserialized list of results from each of the enqueued requests.

type URIClient

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

URIClient is a JSON-RPC client, which sends POST form HTTP requests to the remote server.

URIClient is safe for concurrent use by multiple goroutines.

func NewURI

func NewURI(remote string) (*URIClient, error)

NewURI returns a new client. An error is returned on invalid remote. The function panics when remote is nil.

func (*URIClient) Call

func (c *URIClient) Call(ctx context.Context, method string,
	params map[string]interface{}, result interface{}) (interface{}, error)

Call issues a POST form HTTP request.

type WSClient

type WSClient struct {
	Address  string // IP:PORT or /path/to/socket
	Endpoint string // /websocket/url/endpoint
	Dialer   func(string, string) (net.Conn, error)

	// Single user facing channel to read RPCResponses from, closed only when the
	// client is being stopped.
	ResponsesCh chan types.RPCResponse

	service.BaseService

	// Time between sending a ping and receiving a pong. See
	// https://godoc.org/github.com/rcrowley/go-metrics#Timer.
	PingPongLatencyTimer metrics.Timer
	// contains filtered or unexported fields
}

WSClient is a JSON-RPC client, which uses WebSocket for communication with the remote server.

WSClient is safe for concurrent use by multiple goroutines.

func NewWS

func NewWS(remoteAddr, endpoint string, options ...func(*WSClient)) (*WSClient, error)

NewWS returns a new client. See the commentary on the func(*WSClient) functions for a detailed description of how to configure ping period and pong wait time. The endpoint argument must begin with a `/`. An error is returned on invalid remote. The function panics when remote is nil.

func (*WSClient) Call

func (c *WSClient) Call(ctx context.Context, method string, params map[string]interface{}) error

Call enqueues a call request onto the Send queue. Requests are JSON encoded.

func (*WSClient) CallWithArrayParams

func (c *WSClient) CallWithArrayParams(ctx context.Context, method string, params []interface{}) error

CallWithArrayParams enqueues a call request onto the Send queue. Params are in a form of array (e.g. []interface{}{"abcd"}). Requests are JSON encoded.

func (*WSClient) IsActive

func (c *WSClient) IsActive() bool

IsActive returns true if the client is running and not reconnecting.

func (*WSClient) IsReconnecting

func (c *WSClient) IsReconnecting() bool

IsReconnecting returns true if the client is reconnecting right now.

func (*WSClient) OnStart

func (c *WSClient) OnStart() error

OnStart implements service.Service by dialing a server and creating read and write routines.

func (*WSClient) Send

func (c *WSClient) Send(ctx context.Context, request types.RPCRequest) error

Send the given RPC request to the server. Results will be available on ResponsesCh, errors, if any, on ErrorsCh. Will block until send succeeds or ctx.Done is closed.

func (*WSClient) Stop

func (c *WSClient) Stop() error

Stop overrides service.Service#Stop. There is no other way to wait until Quit channel is closed.

func (*WSClient) String

func (c *WSClient) String() string

String returns WS client full address.

func (*WSClient) Subscribe

func (c *WSClient) Subscribe(ctx context.Context, query string) error

Subscribe to a query. Note the server must have a "subscribe" route defined.

func (*WSClient) Unsubscribe

func (c *WSClient) Unsubscribe(ctx context.Context, query string) error

Unsubscribe from a query. Note the server must have a "unsubscribe" route defined.

func (*WSClient) UnsubscribeAll

func (c *WSClient) UnsubscribeAll(ctx context.Context) error

UnsubscribeAll from all. Note the server must have a "unsubscribe_all" route defined.