Documentation
¶
Index ¶
- func DefaultHTTPClient(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
- type HTTPClient
- type RequestBatch
- type WSClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultHTTPClient ¶
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 MaxReconnectAttempts ¶
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 ¶
PingPeriod sets the duration for sending websocket pings. It should only be used in the constructor - 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 ¶
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 ¶
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 WSClient ¶
type WSClient struct {
Address string // IP:PORT or /path/to/socket
Endpoint string // /websocket/url/endpoint
Dialer func(string, string) (net.Conn, error)
PubKey string
PriKey *ecdsa.PrivateKey
// Single user facing channel to read RPCRequest from, closed only when the
// client is being stopped.
RequestsCh chan types.RPCRequest
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 ¶
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) IsReconnecting ¶
IsReconnecting returns true if the client is reconnecting right now.
func (*WSClient) OnStart ¶
OnStart implements service.Service by dialing a server and creating read and write routines.
func (*WSClient) Send ¶
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.
Source Files