p2p

package
v1.13.0-rc3 Latest Latest
Warning

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

Go to latest
Published: Feb 5, 2024 License: Apache-2.0 Imports: 24 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultConfig = Config{
	Host:              "0.0.0.0",
	Port:              4689,
	ExternalHost:      "",
	ExternalPort:      4689,
	BootstrapNodes:    []string{},
	MasterKey:         "",
	RateLimit:         p2p.DefaultRatelimitConfig,
	ReconnectInterval: 150 * time.Second,
	EnableRateLimit:   true,
	PrivateNetworkPSK: "",
	MaxPeers:          30,
}

DefaultConfig is the default config of p2p

View Source
var (

	// ErrAgentNotStarted is the error returned when p2p agent has not been started
	ErrAgentNotStarted = errors.New("p2p agent has not been started")
)

Functions

This section is empty.

Types

type Agent

type Agent interface {
	lifecycle.StartStopper
	nodestats.StatsReporter
	// BroadcastOutbound sends a broadcast message to the whole network
	BroadcastOutbound(ctx context.Context, msg proto.Message) (err error)
	// UnicastOutbound sends a unicast message to the given address
	UnicastOutbound(_ context.Context, peer peer.AddrInfo, msg proto.Message) (err error)
	// Info returns agents' peer info.
	Info() (peer.AddrInfo, error)
	// Self returns the self network address
	Self() ([]multiaddr.Multiaddr, error)
	// ConnectedPeers returns the connected peers' info
	ConnectedPeers() ([]peer.AddrInfo, error)
	// BlockPeer blocks the peer in p2p layer
	BlockPeer(string)
}

Agent is the agent to help the blockchain node connect into the P2P networks and send/receive messages

func NewAgent

func NewAgent(cfg Config, chainID uint32, genesisHash hash.Hash256, broadcastHandler HandleBroadcastInbound, unicastHandler HandleUnicastInboundAsync) Agent

NewAgent instantiates a local P2P agent instance

func NewDummyAgent added in v1.6.3

func NewDummyAgent() Agent

NewDummyAgent creates a dummy p2p agent

type Config added in v1.8.2

type Config struct {
	Host           string   `yaml:"host"`
	Port           int      `yaml:"port"`
	ExternalHost   string   `yaml:"externalHost"`
	ExternalPort   int      `yaml:"externalPort"`
	BootstrapNodes []string `yaml:"bootstrapNodes"`
	MasterKey      string   `yaml:"masterKey"` // master key will be PrivateKey if not set.
	// RelayType is the type of P2P network relay. By default, the value is empty, meaning disabled. Two relay types
	// are supported: active, nat.
	RelayType         string              `yaml:"relayType"`
	ReconnectInterval time.Duration       `yaml:"reconnectInterval"`
	RateLimit         p2p.RateLimitConfig `yaml:"rateLimit"`
	EnableRateLimit   bool                `yaml:"enableRateLimit"`
	PrivateNetworkPSK string              `yaml:"privateNetworkPSK"`
	MaxPeers          int                 `yaml:"maxPeers"`
}

Config is the config of p2p

type HandleBroadcastInbound

type HandleBroadcastInbound func(context.Context, uint32, string, proto.Message)

HandleBroadcastInbound handles broadcast message when agent listens it from the network

type HandleUnicastInboundAsync

type HandleUnicastInboundAsync func(context.Context, uint32, peer.AddrInfo, proto.Message)

HandleUnicastInboundAsync handles unicast message when agent listens it from the network

type Qos added in v1.3.0

type Qos struct {
	// contains filtered or unexported fields
}

Qos metrics

func NewQoS added in v1.3.0

func NewQoS(now time.Time, timeout time.Duration) *Qos

NewQoS returns the Qos metrics

func (*Qos) BroadcastRecvTotal added in v1.3.0

func (q *Qos) BroadcastRecvTotal() uint64

BroadcastRecvTotal returns the total amount of broadcast received

func (*Qos) BroadcastSendSuccessRate added in v1.3.0

func (q *Qos) BroadcastSendSuccessRate() float64

BroadcastSendSuccessRate returns the broadcast send success rate

func (*Qos) BroadcastSendTotal added in v1.3.0

func (q *Qos) BroadcastSendTotal() uint64

BroadcastSendTotal returns the total amount of broadcast sent

func (*Qos) UnicastRecvTotal added in v1.3.0

func (q *Qos) UnicastRecvTotal(peername string) (uint64, bool)

UnicastRecvTotal returns the total amount of unicast received from peer

func (*Qos) UnicastSendSuccessRate added in v1.3.0

func (q *Qos) UnicastSendSuccessRate(peername string) (float64, bool)

UnicastSendSuccessRate returns the unicast send success rate

func (*Qos) UnicastSendTotal added in v1.3.0

func (q *Qos) UnicastSendTotal(peername string) (uint64, bool)

UnicastSendTotal returns the total amount of unicast sent to peer

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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