Categorygithub.com/libp2p/go-libp2p-interface-conn
modulepackage
0.0.0-20180608185345-c7cda99284db
Repository: https://github.com/libp2p/go-libp2p-interface-conn.git
Documentation: pkg.go.dev

# README

[DEPRECATED] go-libp2p-interface-conn

This package has been deprecated and is no loner used by go-libp2p. Libp2p used to build up connections as follows:

  1. go "net" conn
  2. multiaddr conn -- net conn with multiaddrs
  3. go-libp2p-transport conn -- multiaddr conns with associated transports
  4. this package -- secured, multiplexed connections
  5. go-libp2p-net conn -- connections associated with a Network (e.g., go-libp2p-swarm).

However, go-libp2p-transport connections are now fully secured and multiplexed so the interfaces in this package have been subsumed by those in go-libp2p-transport.

Interfaces to implement to create a connection object for use in libp2p.

Table of Contents

Install

make install

Contribute

PRs are welcome!

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

License

MIT © Jeromy Johnson

# Functions

ID returns the ID of a given Conn.
String returns the user-friendly String representation of a conn.

# Variables

EncryptConnections is a global parameter because it should either be enabled or _completely disabled_.

# Interfaces

Conn is a generic message-based Peer-to-Peer connection.
Listener is an object that can accept connections.
No description provided by the author