ws

package

v0.1.6-0...-5c25bcb Latest Latest Go to latest Published: Feb 1, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

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

Rendered for

This section is empty.

This section is empty.

func Accept(w http.ResponseWriter, r *http.Request) (*websocket.Conn, error)

Accept accepts a WebSocket handshake from a client and upgrades the the connection to a WebSocket.

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

Inbound http(ws) type.

func NewInbound(internalAddr, externalAddr, certFile, keyFile string) (*Inbound, error)

NewInbound creates a new WebSocket inbound transport instance.

func (i *Inbound) Endpoint() string

Endpoint provides the http(ws) connection details.

func (i *Inbound) Start(prov transport.Provider) error

Start the http(ws) server.

func (i *Inbound) Stop() error

Stop the http(ws) server.

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

OutboundClient websocket outbound.

func NewOutbound() *OutboundClient

NewOutbound creates a client for Outbound WS transport.

func (cs *OutboundClient) Accept(url string) bool

Accept checks for the url scheme.

func (cs *OutboundClient) AcceptRecipient(keys []string) bool

AcceptRecipient checks if there is a connection for the list of recipient keys.

func (cs *OutboundClient) Send(data []byte, destination *service.Destination) (string, error)

Send sends a2a data via WS.

func (cs *OutboundClient) Start(prov transport.Provider) error

Start starts the outbound transport.