wsclient

package

v0.13.0 Latest Latest Go to latest Published: Feb 14, 2022 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hyperledger/firefly

Links

Open Source Insights

Documentation ¶

Index ¶

func NewTestWSServer(testReq func(req *http.Request)) (toServer, fromServer chan string, url string, done func())
type WSClient
- func New(ctx context.Context, config *WSConfig, beforeConnect WSPreConnectHandler, ...) (WSClient, error)
type WSConfig
type WSPostConnectHandler
type WSPreConnectHandler

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewTestWSServer ¶

func NewTestWSServer(testReq func(req *http.Request)) (toServer, fromServer chan string, url string, done func())

NewTestWSServer creates a little test server for packages (including wsclient itself) to use in unit tests

Types ¶

type WSClient ¶

type WSClient interface {
	Connect() error
	Receive() <-chan []byte
	URL() string
	SetURL(url string)
	Send(ctx context.Context, message []byte) error
	Close()
}

func New ¶

func New(ctx context.Context, config *WSConfig, beforeConnect WSPreConnectHandler, afterConnect WSPostConnectHandler) (WSClient, error)

type WSConfig ¶

type WSConfig struct {
	HTTPURL                string             `json:"httpUrl,omitempty"`
	WSKeyPath              string             `json:"wsKeyPath,omitempty"`
	ReadBufferSize         int                `json:"readBufferSize,omitempty"`
	WriteBufferSize        int                `json:"writeBufferSize,omitempty"`
	InitialDelay           time.Duration      `json:"initialDelay,omitempty"`
	MaximumDelay           time.Duration      `json:"maximumDelay,omitempty"`
	InitialConnectAttempts int                `json:"initialConnectAttempts,omitempty"`
	AuthUsername           string             `json:"authUsername,omitempty"`
	AuthPassword           string             `json:"authPassword,omitempty"`
	HTTPHeaders            fftypes.JSONObject `json:"headers,omitempty"`
	HeartbeatInterval      time.Duration      `json:"heartbeatInterval,omitempty"`
}

type WSPostConnectHandler ¶

type WSPostConnectHandler func(ctx context.Context, w WSClient) error

WSPostConnectHandler will be called after every connect/reconnect. Can send data over ws, but must not block listening for data on the ws.

type WSPreConnectHandler ¶ added in v0.13.0

type WSPreConnectHandler func(ctx context.Context) error

WSPreConnectHandler will be called before every connect/reconnect. Any error returned will prevent the websocket from connecting.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL