wsclient

package

v0.0.0-...-4c73ccb Latest Latest Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func GenerateRequestID() (requestID string)

GenerateRequestID generates unique request ID.

type Client struct {
	ErrorChannel chan error

	sync.Mutex
	// contains filtered or unexported fields
}

Client VIS client object.

func New(name string, clientParam ClientParam, messageHandler func([]byte)) (client *Client, err error)

New creates new ws client.

func (client *Client) Close() (err error)

Close closes ws client.

func (client *Client) Connect(url string) (err error)

Connect connects to ws server.

func (client *Client) Disconnect() (err error)

Disconnect disconnects from ws server.

func (client *Client) IsConnected() (result bool)

IsConnected returns true if connected to ws server.

func (client *Client) SendMessage(message interface{}) (err error)

SendMessage sends message without waiting for response.

func (client *Client) SendRequest(idField string, idValue interface{}, req interface{}, rsp interface{}) (err error)

SendRequest sends request and waits for response.

type ClientParam struct {
	CaCertFile       string
	WebSocketTimeout time.Duration
}

ClientParam client parameters.