ws

Documentation

Index

• Constants
• type Connection
  • func NewWS(wsURL string, opts Options) (*Connection, error)
  • func (wsInsp *Connection) Close()
  • func (wsInsp *Connection) Hostname() string
  • func (wsInsp *Connection) Messages() <-chan Message
  • func (wsInsp *Connection) Send(msg string) (*Message, error)
• type ConnectionHandler
• type Message
• type MessageType
  • func (mt MessageType) String() string
• type Options

Constants

const (
	WSMessageBufferSize = 100
	HeaderPartsNumber   = 2
)

Types

type Connection

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

func NewWS

func NewWS(wsURL string, opts Options) (*Connection, error)

NewWS creates a new WebSocket connection to the specified URL with the given options. It returns a Connection object and an error if any occurred.

func (*Connection) Close

func (wsInsp *Connection) Close()

Close closes the WebSocket connection. If the connection is already closed, it returns immediately.

func (*Connection) Hostname

func (wsInsp *Connection) Hostname() string

Hostname returns the hostname of the WebSocket server.

func (*Connection) Messages

func (wsInsp *Connection) Messages() <-chan Message

Messages returns a channel that receives messages from the WebSocket connection.

func (*Connection) Send

func (wsInsp *Connection) Send(msg string) (*Message, error)

Send sends a message to the websocket connection and returns a Message and an error. It takes a string message as input and returns a pointer to a Message struct and an error. The Message struct contains the message type and data.

type ConnectionHandler

type ConnectionHandler interface {
	Messages() <-chan Message
	Hostname() string
	Send(msg string) (*Message, error)
	Close()
}

type Message

type Message struct {
	Data string      `json:"data"`
	Type MessageType `json:"type"`
}

type MessageType

type MessageType uint8

const (
	NotDefined MessageType = iota
	Request
	Response
)

func (MessageType) String

func (mt MessageType) String() string

type Options

type Options struct {
	Headers             []string
	SkipSSLVerification bool
}