wsport

package module

v0.0.9 Latest Latest Go to latest Published: Dec 19, 2024 License: MIT Imports: 20 Imported by: 9

Details

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

Repository

github.com/btwiuse/wsport

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

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

Index ¶

func ConvertWebsocketMultiaddrToNetAddr(maddr ma.Multiaddr) (net.Addr, error)
func DialConn(ctx context.Context, addr string, hdr http.Header) (conn net.Conn, err error)
func FromString(s string) (ma.Multiaddr, error)
func FromURL(a *url.URL) (ma.Multiaddr, error)
func ListenAddrStrings(s ...string) libp2p.Option
func ParseWebsocketNetAddr(a net.Addr) (ma.Multiaddr, error)
type Addr
- func NewAddr(host string) *Addr
- func NewAddrWithScheme(host string, isSecure bool) *Addr
- func (addr *Addr) Network() string
type ConnAddr
type MyConn
- func (c *MyConn) LocalMultiaddr() ma.Multiaddr
- func (c *MyConn) RemoteMultiaddr() ma.Multiaddr
type Option
- func WithTLSClientConfig(c *tls.Config) Option
- func WithTLSConfig(conf *tls.Config) Option
type WebsocketTransport
- func New(u transport.Upgrader, rcmgr network.ResourceManager, opts ...Option) (*WebsocketTransport, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ConvertWebsocketMultiaddrToNetAddr ¶

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

func DialConn ¶ added in v0.0.1

func DialConn(ctx context.Context, addr string, hdr http.Header) (conn net.Conn, err error)

func FromString ¶ added in v0.0.1

func FromString(s string) (ma.Multiaddr, error)

func FromURL ¶ added in v0.0.1

func FromURL(a *url.URL) (ma.Multiaddr, error)

func ListenAddrStrings ¶ added in v0.0.1

func ListenAddrStrings(s ...string) libp2p.Option

ListenAddrStrings configures libp2p to listen on the given (unparsed) ws:// or wss:// addresses.

func ParseWebsocketNetAddr ¶

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

Types ¶

type Addr ¶

type Addr struct {
	*url.URL
}

Addr is an implementation of net.Addr for WebSocket.

func NewAddr ¶

func NewAddr(host string) *Addr

NewAddr creates an Addr with `ws` scheme (insecure).

Deprecated. Use NewAddrWithScheme.

func NewAddrWithScheme ¶

func NewAddrWithScheme(host string, isSecure bool) *Addr

NewAddrWithScheme creates a new Addr using the given host string. isSecure should be true for WSS connections and false for WS.

func (*Addr) Network ¶

func (addr *Addr) Network() string

Network returns the network type for a WebSocket, "websocket".

type ConnAddr ¶ added in v0.0.7

type ConnAddr struct {
	Conn net.Conn
	Addr string
}

type MyConn ¶

type MyConn struct {
	net.Conn
	Addr   string
	Secure bool
}

func (*MyConn) LocalMultiaddr ¶

func (c *MyConn) LocalMultiaddr() ma.Multiaddr

func (*MyConn) RemoteMultiaddr ¶

func (c *MyConn) RemoteMultiaddr() ma.Multiaddr

fix websocket/unknown-unknown

type Option ¶

type Option func(*WebsocketTransport) error

func WithTLSClientConfig ¶

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 ¶

func WithTLSConfig(conf *tls.Config) Option

WithTLSConfig sets a TLS configuration for the WebSocket listener.

type WebsocketTransport ¶

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

WebsocketTransport is the actual go-libp2p transport

func New ¶

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

func (*WebsocketTransport) CanDial ¶

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

func (*WebsocketTransport) Dial ¶

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

func (*WebsocketTransport) Listen ¶

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

func (*WebsocketTransport) Protocols ¶

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

func (*WebsocketTransport) Proxy ¶

func (t *WebsocketTransport) Proxy() bool

func (*WebsocketTransport) Resolve ¶

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd module

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