core

package module
Version: v0.10.0 Latest Latest
Warning

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

Go to latest
Published: Sep 8, 2021 License: Apache-2.0, MIT, Apache-2.0, MIT Imports: 5 Imported by: 111

README

go-libp2p-core

GoDoc Coverage Status Build Status Discourse posts

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

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-libp2p 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 github.com/multiformats/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.

Source Files

Directories

Path Synopsis
Package connmgr provides connection tracking and management interfaces for libp2p.
Package connmgr provides connection tracking and management interfaces for libp2p.
Package crypto implements various cryptographic utilities used by libp2p.
Package crypto implements various cryptographic utilities used by libp2p.
pb
Package discovery provides service advertisement and peer discovery interfaces for libp2p.
Package discovery provides service advertisement and peer discovery interfaces for libp2p.
Package event contains the abstractions for a local event bus, along with the standard events that libp2p subsystems may emit.
Package event contains the abstractions for a local event bus, along with the standard events that libp2p subsystems may emit.
Package host provides the core Host interface for libp2p.
Package host provides the core Host interface for libp2p.
Package introspection is EXPERIMENTAL.
Package introspection is EXPERIMENTAL.
pb
Package introspection/pb contains the protobuf definitions and objects for that form the libp2p introspection protocol.
Package introspection/pb contains the protobuf definitions and objects for that form the libp2p introspection protocol.
Package metrics provides metrics collection and reporting interfaces for libp2p.
Package metrics provides metrics collection and reporting interfaces for libp2p.
Package mux provides stream multiplexing interfaces for libp2p.
Package mux provides stream multiplexing interfaces for libp2p.
Package network provides core networking abstractions for libp2p.
Package network provides core networking abstractions for libp2p.
Package peer implements an object used to represent peers in the libp2p network.
Package peer implements an object used to represent peers in the libp2p network.
pb
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about libp2p peers.
Package peerstore provides types and interfaces for local storage of address information, metadata, and public key material about libp2p peers.
Package pnet provides interfaces for private networking in libp2p.
Package pnet provides interfaces for private networking in libp2p.
Package protocol provides core interfaces for protocol routing and negotiation in libp2p.
Package protocol provides core interfaces for protocol routing and negotiation in libp2p.
pb
Package routing provides interfaces for peer routing and content routing in libp2p.
Package routing provides interfaces for peer routing and content routing in libp2p.
sec
Package sec provides secure connection and transport interfaces for libp2p.
Package sec provides secure connection and transport interfaces for libp2p.
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