Categorygithub.com/wms2537/go-libp2p-webrtc-direct
modulepackage
0.0.0-20221101024806-3ebbb503772c
Repository: https://github.com/wms2537/go-libp2p-webrtc-direct.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
22
Dependents
0
Files
757 SLOC

# README

go-libp2p-webrtc-direct

GoDoc Coverage Status Build Status

A transport that enables browser-to-server, and server-to-server, direct communication over WebRTC without requiring signalling servers. This is the Go counterpart to js-libp2p-webrtc-direct.

⚠️ Status: Alpha. ⚠️

Lead maintainer: @backkem

Special thanks to @pion for their fantastic WebRTC Go library, which made this libp2p transport possible.

Install

This package supports gomod builds.

go get github.com/libp2p/go-libp2p-webrtc-direct

Usage

Check out the GoDocs.

Examples

Check the examples folder for usage and integration examples.

Contribute

Feel free to join in. All welcome. Open an issue or send a PR.

This repository falls under the IPFS Code of Conduct.

License

MIT

# Functions

NewTransport creates a WebRTC transport that signals over a direct HTTP connection.

# Structs

Conn is a stream-multiplexing connection to a remote peer.
Listener is an interface closely resembling the net.Listener interface.
Stream is a bidirectional io pipe within a connection.
Transport is the WebRTC transport.