core

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2021 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 5 Imported by: 1

README

go-libp2p-core

GoDoc Coverage Status Build Status Discourse posts

Home to the interfaces and abstractions that make up go-libp2p.

Minimum go version: 1.13

Install

go get github.com/libp2p/go-libp2p-core

Usage

Check out the GoDocs.

Testing

To test instantiations of interfaces and abstractions, you can use the test suite.

License

Dual-licensed under MIT and ASLv2, by way of the Permissive License Stack.

Documentation

Overview

Package core provides convenient access to foundational, central go-p2p primitives via type aliases.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Conn

type Conn = network.Conn

Conn aliases network.Conn.

Refer to the docs on that type for more info.

type Host

type Host = host.Host

Host aliases host.Host.

Refer to the docs on that type for more info.

type Multiaddr

type Multiaddr = multiaddr.Multiaddr

Multiaddr aliases the Multiaddr type from gitlab.dms3.io/mf/go-multiaddr.

Refer to the docs on that type for more info.

type Network

type Network = network.Network

Network aliases network.Network.

Refer to the docs on that type for more info.

type PeerAddrInfo

type PeerAddrInfo = peer.AddrInfo

PeerAddrInfo aliases peer.AddrInfo.

Refer to the docs on that type for more info.

type PeerID

type PeerID = peer.ID

PeerID aliases peer.ID.

Refer to the docs on that type for more info.

type ProtocolID

type ProtocolID = protocol.ID

ProtocolID aliases protocol.ID.

Refer to the docs on that type for more info.

type Stream

type Stream = network.Stream

Stream aliases network.Stream.

Refer to the docs on that type for more info.

Directories

Path Synopsis
Package connmgr provides connection tracking and management interfaces for p2p.
Package connmgr provides connection tracking and management interfaces for p2p.
Package crypto implements various cryptographic utilities used by p2p.
Package crypto implements various cryptographic utilities used by p2p.
pb
Package discovery provides service advertisement and peer discovery interfaces for p2p.
Package discovery provides service advertisement and peer discovery interfaces for p2p.
Package event contains the abstractions for a local event bus, along with the standard events that p2p subsystems may emit.
Package event contains the abstractions for a local event bus, along with the standard events that p2p subsystems may emit.
Package host provides the core Host interface for p2p.
Package host provides the core Host interface for p2p.
Package introspection is EXPERIMENTAL.
Package introspection is EXPERIMENTAL.
pb
Package metrics provides metrics collection and reporting interfaces for p2p.
Package metrics provides metrics collection and reporting interfaces for p2p.
Package mux provides stream multiplexing interfaces for p2p.
Package mux provides stream multiplexing interfaces for p2p.
Package network provides core networking abstractions for p2p.
Package network provides core networking abstractions for p2p.
Package peer implements an object used to represent peers in the p2p network.
Package peer implements an object used to represent peers in the p2p network.
pb
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about p2p peers.
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about p2p peers.
Package pnet provides interfaces for private networking in p2p.
Package pnet provides interfaces for private networking in p2p.
Package protocol provides core interfaces for protocol routing and negotiation in p2p.
Package protocol provides core interfaces for protocol routing and negotiation in p2p.
pb
Package routing provides interfaces for peer routing and content routing in p2p.
Package routing provides interfaces for peer routing and content routing in p2p.
sec
Package sec provides secure connection and transport interfaces for p2p.
Package sec provides secure connection and transport interfaces for p2p.
insecure
Package insecure provides an insecure, unencrypted implementation of the the SecureConn and SecureTransport interfaces.
Package insecure provides an insecure, unencrypted implementation of the the SecureConn and SecureTransport interfaces.
Package transport provides the Transport interface, which represents the devices and network protocols used to send and receive data.
Package transport provides the Transport interface, which represents the devices and network protocols used to send and receive data.

Jump to

Keyboard shortcuts

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