websocket

Documentation

Index

• Constants
• Variables
• type ConnectedEvent
  • func (e *ConnectedEvent) String() string
• type ConnectingEvent
  • func (e *ConnectingEvent) String() string
• type DialTimeoutEvent
  • func (e *DialTimeoutEvent) String() string
• type DisconnectedEvent
  • func (e *DisconnectedEvent) String() string
• type Option
  • func SetAutoReconnectEnabled(enabled bool) Option
  • func SetAutoReconnectMaxDelay(delay time.Duration) Option
  • func SetDialTimeout(timeout time.Duration) Option
  • func SetMonitor(monitorChan chan<- interface{}) Option
  • func SetReadTimeout(timeout time.Duration) Option
  • func SetReadWriteTimeout(timeout time.Duration) Option
  • func SetWriteTimeout(timeout time.Duration) Option
• type Transport
  • func NewTransport(endpointURL string, options ...Option) (*Transport, error)
  • func (t *Transport) Call(method string, params, response interface{}) error
  • func (t *Transport) Close() error

Constants

const (
	DefaultDialTimeout           = 30 * time.Second
	DefaultAutoReconnectMaxDelay = 5 * time.Minute
)

Variables

var (
	ErrClosing = errors.New("closing")
)

Types

type ConnectedEvent

type ConnectedEvent struct {
	URL string
}

ConnectedEvent is emitted when the WebSocket connection is established.

func (*ConnectedEvent) String

func (e *ConnectedEvent) String() string

type ConnectingEvent

type ConnectingEvent struct {
	URL string
}

ConnectingEvent is emitted when a new connection is being established.

func (*ConnectingEvent) String

func (e *ConnectingEvent) String() string

type DialTimeoutEvent

type DialTimeoutEvent struct {
	URL     string
	Err     error
	Timeout time.Duration
}

DialTimeoutEvent is emitted when establishing a new connection times out.

func (*DialTimeoutEvent) String

func (e *DialTimeoutEvent) String() string

type DisconnectedEvent

type DisconnectedEvent struct {
	URL string
	Err error
}

DisconnectedEvent is emitted when the WebSocket connection is lost.

func (*DisconnectedEvent) String

func (e *DisconnectedEvent) String() string

type Option

type Option func(*Transport)

Option represents an option that can be passed into the transport constructor.

func SetAutoReconnectEnabled

func SetAutoReconnectEnabled(enabled bool) Option

SetAutoReconnectEnabled can be used to enable automatic reconnection to the RPC endpoint. Exponential backoff is used when the connection cannot be established repetitively.

See SetAutoReconnectMaxDelay to set the maximum delay between the reconnection attempts.

func SetAutoReconnectMaxDelay

func SetAutoReconnectMaxDelay(delay time.Duration) Option

SetAutoReconnectMaxDelay can be used to set the maximum delay between the reconnection attempts.

This option only takes effect when the auto-reconnect mode is enabled.

The default value is 5 minutes.

func SetDialTimeout

func SetDialTimeout(timeout time.Duration) Option

SetDialTimeout can be used to set the timeout when establishing a new connection.

func SetMonitor

func SetMonitor(monitorChan chan<- interface{}) Option

SetMonitor can be used to set the monitoring channel that can be used to watch connection-related state changes.

All channel send operations are happening synchronously, so not receiving messages from the channel will lead to the whole thing getting stuck completely.

This option only takes effect when the auto-reconnect mode is enabled.

The channel is closed when the transport is closed.

func SetReadTimeout

func SetReadTimeout(timeout time.Duration) Option

SetReadTimeout sets the connection read timeout. The timeout is implemented using net.Conn.SetReadDeadline.

func SetReadWriteTimeout

func SetReadWriteTimeout(timeout time.Duration) Option

SetReadWriteTimeout sets the connection read and write timeout. The timeout is implemented using net.Conn.SetDeadline.

func SetWriteTimeout

func SetWriteTimeout(timeout time.Duration) Option

SetWriteTimeout sets the connection read timeout. The timeout is implemented using net.Conn.SetWriteDeadline.

type Transport

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

Transport implements a CallCloser accessing the Steem RPC endpoint over WebSocket.

func NewTransport

func NewTransport(endpointURL string, options ...Option) (*Transport, error)

NewTransport creates a new transport that connects to the given WebSocket URL.

func (*Transport) Call

func (t *Transport) Call(method string, params, response interface{}) error

Call implements interfaces.CallCloser.

func (*Transport) Close

func (t *Transport) Close() error

Close implements interfaces.CallCloser.