websocket_path

README

go-libp2p-websocket-path

libp2p websocket transport with path

Transport:

libp2p.Transport(path_websocket.New)

Connect:

addr, err := websocket_path.NewMultiaddr("/dns4/your.ipfs.server.io/tcp/443/tls/ws+path/(/ipfs/ws)/p2p/12D3KooXXXXXXXXXX")
info, err := peer.AddrInfoFromP2pAddr(addr)
lite.Bootstrap([]peer.AddrInfo{*info})

License

MIT License

Documentation

Index

• Constants
• Variables
• func ConvertWebsocketMultiaddrToNetAddr(maddr ma.Multiaddr) (net.Addr, error)
• func NewMultiaddr(address string) (multiaddr.Multiaddr, error)
• func ParseWebsocketNetAddr(a net.Addr) (ma.Multiaddr, error)
• type Addr
  • func NewLocalAddrWithScheme(host string, isSecure bool) Addr
  • func (a Addr) Network() string
• type Conn
  • func NewConnWithAddr(raw *ws.Conn, secure bool, remoteAddr Addr) *Conn
  • func (c *Conn) Close() error
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) Read(b []byte) (int, error)
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetReadDeadline(t time.Time) error
  • func (c *Conn) SetWriteDeadline(t time.Time) error
  • func (c *Conn) Write(b []byte) (n int, err error)
• 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)
  • 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)

Constants

const (
	P_WS_PATH = 0x3001dd
)

Variables

var GracefulCloseTimeout = 100 * time.Millisecond

GracefulCloseTimeout is the time to wait trying to gracefully close a connection before simply cutting it.

var WsFmt = mafmt.And(mafmt.TCP, mafmt.Base(P_WS_PATH))

WsFmt is multiaddr formatter for WsProtocol

Functions

func ConvertWebsocketMultiaddrToNetAddr

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

func NewMultiaddr

func NewMultiaddr(address string) (multiaddr.Multiaddr, error)

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 NewLocalAddrWithScheme

func NewLocalAddrWithScheme(host string, isSecure bool) Addr

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

func (Addr) Network

func (a Addr) Network() string

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

type Conn

type Conn struct {
	*ws.Conn

	DefaultMessageType int
	// contains filtered or unexported fields
}

func NewConnWithAddr

func NewConnWithAddr(raw *ws.Conn, secure bool, remoteAddr Addr) *Conn

NewConnWithAddr creates a Conn given a regular gorilla/websocket Conn.

func (*Conn) Close

func (c *Conn) Close() error

Close closes the connection. Only the first call to Close will receive the close error, subsequent and concurrent calls will return nil. This method is thread-safe.

func (*Conn) LocalAddr

func (c *Conn) LocalAddr() net.Addr

func (*Conn) Read

func (c *Conn) Read(b []byte) (int, error)

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() net.Addr

func (*Conn) SetDeadline

func (c *Conn) SetDeadline(t time.Time) error

func (*Conn) SetReadDeadline

func (c *Conn) SetReadDeadline(t time.Time) error

func (*Conn) SetWriteDeadline

func (c *Conn) SetWriteDeadline(t time.Time) error

func (*Conn) Write

func (c *Conn) Write(b []byte) (n int, err error)

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(ctx context.Context, maddr ma.Multiaddr) ([]ma.Multiaddr, error)