ipnet

README

go-libp2p-interface-pnet

An interface providing abstraction of swarm protection for libp2p.

Table of Contents

• Usage
• Contribute
• License

Usage

Core of this interface in Protector that is used to protect the swarm. It makes decisions about which streams are allowed to pass.

This interface is accepted in multiple places in libp2p but most importantly in go-libp2p-swarm NewSwarmWithProtector and NewNetworkWithProtector.

Implementations:

• go-libp2p-pnet - simple PSK based Protector, using XSalsa20

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: 3.0.0: QmW7Ump7YyBMr712Ta3iEVh3ZYcfVvJaPryfbCnyE826b4

Documentation

Overview

Deprecated: use github.com/libp2p/go-libp2p-core/pnet instead.

Index

• Constants
• Variables
• func IsPNetError(err error) bool
• func NewError(err string) error
• type PNetError
• type Protector

Constants

const EnvKey = core.EnvKey

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.EnvKey instead.

Variables

var ErrNotInPrivateNetwork = core.ErrNotInPrivateNetwork

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.ErrNotInPrivateNetwork instead.

Functions

func IsPNetError

func IsPNetError(err error) bool

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.IsPNetError instead.

func NewError

func NewError(err string) error

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.NewError instead.

Types

type PNetError

type PNetError = core.Error

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.Error instead.

type Protector

type Protector = core.Protector

Deprecated: use github.com/libp2p/go-libp2p-core/pnet.Protector instead.