Categorygithub.com/libp2p/go-libp2p-circuit
modulepackage
0.6.0
Repository: https://github.com/libp2p/go-libp2p-circuit.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
21
Dependents
119
Files
830 SLOC

# README

go-libp2p-circuit

Coverage Status Travis CI Discourse posts

The libp2p relay allows peers to relay connections on behalf of others.

Table of Contents

Install

go get -u github.com/libp2p/go-libp2p-circuit

Usage

Refer to the relay example in the go-libp2p-examples repository for usage instructions.

Contribute

PRs are welcome!

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Jeromy Johnson

The last gx published version of this module was: 2.3.15: QmRTkLxADQRbgnhpt2zzQQJr8Ri764b7dujoDkZw33b3iE

# Packages

No description provided by the author

# Functions

AddRelayTransport constructs a relay and adds it as a transport to the host network.
Queries a peer for support of hop relay.
NewRelay constructs a new relay.

# Constants

No description provided by the author

# Variables

No description provided by the author
No description provided by the author
512K hops for 1M goroutines.
HopTagWeight is the connection manager weight for connections carrying relay hop streams.
OptActive configures the relay transport to actively establish outbound connections on behalf of clients.
OptDiscovery is a no-op.
OptHop configures the relay transport to accept requests to relay traffic on behalf of third-parties.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
Relay is the relay transport and service.
No description provided by the author

# Type aliases

No description provided by the author
RelayOpts are options for configuring the relay transport.
No description provided by the author