websocket

package

v0.0.0-...-a4f63c7 Latest Latest Go to latest Published: Apr 11, 2023 License: MIT, Apache-2.0, MIT Imports: 16 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

Package websocket implements a websocket based transport for go-libp2p.

This section is empty.

View Source

var WsFmt = mafmt.And(mafmt.TCP, mafmt.Base(ma.P_WS))

WsFmt is multiaddr formatter for WsProtocol

func ConvertWebsocketMultiaddrToNetAddr(maddr ma.Multiaddr) (net.Addr, error)

func ParseWebsocketNetAddr(a net.Addr) (ma.Multiaddr, error)

type Option func(*WebsocketTransport) error

func WithTLSClientConfig(c *tls.Config) Option

WithTLSClientConfig sets a TLS client configuration on the WebSocket Dialer. Only relevant for non-browser usages.

Some useful use cases include setting InsecureSkipVerify to `true`, or setting user-defined trusted CA certificates.

func WithTLSConfig(conf *tls.Config) Option

WithTLSConfig sets a TLS configuration for the WebSocket listener.

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

WebsocketTransport is the actual go-libp2p transport

func New(u transport.Upgrader, rcmgr network.ResourceManager, opts ...Option) (*WebsocketTransport, error)

func (t *WebsocketTransport) CanDial(a ma.Multiaddr) bool

func (t *WebsocketTransport) Dial(ctx context.Context, raddr ma.Multiaddr, p peer.ID) (transport.CapableConn, error)

func (t *WebsocketTransport) Listen(a ma.Multiaddr) (transport.Listener, error)

func (t *WebsocketTransport) Protocols() []int

func (t *WebsocketTransport) Proxy() bool

func (t *WebsocketTransport) Resolve(ctx context.Context, maddr ma.Multiaddr) ([]ma.Multiaddr, error)