rpc

Documentation

Index

• type Backend
• type Client
• type ServerInfo
• type Status

Types

type Backend

type Backend interface {
	EstablishConnection() (io.ReadWriteCloser, error)
	ServerInfo() *ServerInfo
}

Backend describes the methods provided to connect to an RPC backend

type Client

type Client interface {
	Method(func([]byte) error, func() func(error), string, ...interface{})
	MethodSync(interface{}, string, ...interface{}) error
	SubscribeNotifications(string, func([]byte))
	Close()
	IsClosed() bool
	RegisterHeartbeat(string, ...interface{})
	OnConnect(func() error)
	ConnectionStatus() Status
	RegisterOnConnectionStatusChangedEvent(func(Status))
}

Client describes the methods needed to communicate with an RPC server.

type ServerInfo

type ServerInfo struct {
	Server  string `json:"server"`
	TLS     bool   `json:"tls"`
	PEMCert string `json:"pemCert"`
}

ServerInfo holds information about the backend server(s).

type Status

type Status int

Status is the connection status to the blockchain node

const (
	// CONNECTED indicates that we are online
	CONNECTED Status = iota
	// DISCONNECTED indicates that we are offline
	DISCONNECTED
)