Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
NewRequest(service ServiceType, rpcEndpoint Endpoint, opt interface{}) (*Request, error)
Do(req *Request, v interface{}) (*http.Response, error)
SetBaseURL(url *url.URL) error
// SubscribeSelf subscribes to responses to requests from this service
SubscribeSelf() error
// Subscribe adds a subscription to events from a particular service
Subscribe(service string) error
// ListenSync Listens for async responses over the connection in a synchronous fashion, blocking anything else
ListenSync(handler WebsocketResponseHandler) error
// AddDisconnectHandler adds a function to call if the connection is disconnected
// Applies to websocket connections
AddDisconnectHandler(onDisconnect DisconnectHandler)
// AddReconnectHandler adds a function to call if the connection is reconnected
// Applies to websocket connections
AddReconnectHandler(onReconnect ReconnectHandler)
}
Client defines the interface for a client HTTP (standard RPC) and websockets are the two supported now
type ClientOptionFunc ¶
ClientOptionFunc can be used to customize a new RPC client.
type ConfigOptionFunc ¶
type ConfigOptionFunc func() (*config.ChikConfig, error)
ConfigOptionFunc used to specify how to load configuration for the RPC client
type DisconnectHandler ¶
type DisconnectHandler func()
DisconnectHandler the function to call when the client is disconnected
type ReconnectHandler ¶
type ReconnectHandler func()
ReconnectHandler the function to call when the client is reconnected
type Request ¶
type Request struct {
Service ServiceType
Endpoint Endpoint
Data interface{}
Request *http.Request
}
Request is a wrapped http.Request that indicates the service we're making the RPC call to
type ServiceType ¶
type ServiceType uint8
ServiceType is a type that refers to a particular service
const ( // ServiceDaemon the daemon ServiceDaemon ServiceType = iota // ServiceFullNode the full node service ServiceFullNode // ServiceFarmer the farmer service ServiceFarmer // ServiceHarvester the harvester service ServiceHarvester // ServiceWallet the wallet service ServiceWallet // ServiceTimelord is the timelord service ServiceTimelord // ServicePeer full node service, but for communicating with full nodes using the public protocol ServicePeer // ServiceCrawler crawler service ServiceCrawler // ServiceDataLayer datalayer service ServiceDataLayer )
type WebsocketResponseHandler ¶
type WebsocketResponseHandler func(*types.WebsocketResponse, error)
WebsocketResponseHandler is a function that is called to process a received websocket response
Source Files
Click to show internal directories.
Click to hide internal directories.