libp2p

package

v2.7.0-rc7 Latest Latest Go to latest Published: Nov 28, 2025 License: BSD-3-Clause Imports: 65 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethersphere/bee

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
type Options
type Service
- func New(ctx context.Context, signer beecrypto.Signer, networkID uint64, ...) (s *Service, returnErr error)

Constants ¶

View Source

const (
	IncomingStreamCountLimit = 5_000
	OutgoingStreamCountLimit = 10_000
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	PrivateKey                  *ecdsa.PrivateKey
	NATAddr                     string
	NATWSSAddr                  string
	EnableWS                    bool
	EnableWSS                   bool
	WSSAddr                     string
	AutoTLSStorageDir           string
	AutoTLSCAEndpoint           string
	AutoTLSDomain               string
	AutoTLSRegistrationEndpoint string
	FullNode                    bool
	LightNodeLimit              int
	WelcomeMessage              string
	Nonce                       []byte
	ValidateOverlay             bool

	HeadersRWTimeout time.Duration
	Registry         *prometheus.Registry
	// contains filtered or unexported fields
}

type Service ¶

type Service struct {
	HeadersRWTimeout time.Duration
	// contains filtered or unexported fields
}

func New ¶

func New(ctx context.Context, signer beecrypto.Signer, networkID uint64, overlay swarm.Address, addr string, ab addressbook.Putter, storer storage.StateStorer, lightNodes *lightnode.Container, logger log.Logger, tracer *tracing.Tracer, o Options) (s *Service, returnErr error)

func (*Service) AddProtocol ¶

func (s *Service) AddProtocol(p p2p.ProtocolSpec) (err error)

func (*Service) Addresses ¶

func (s *Service) Addresses() (addresses []ma.Multiaddr, err error)

func (*Service) Blocklist ¶

func (s *Service) Blocklist(overlay swarm.Address, duration time.Duration, reason string) error

func (*Service) Blocklisted ¶

func (s *Service) Blocklisted(overlay swarm.Address) (bool, error)

func (*Service) BlocklistedPeers ¶

func (s *Service) BlocklistedPeers() ([]p2p.BlockListedPeer, error)

func (*Service) Close ¶

func (s *Service) Close() error

func (*Service) Connect ¶

func (s *Service) Connect(ctx context.Context, addrs []ma.Multiaddr) (address *bzz.Address, err error)

func (*Service) Disconnect ¶

func (s *Service) Disconnect(overlay swarm.Address, reason string) (err error)

func (*Service) GetWelcomeMessage ¶

func (s *Service) GetWelcomeMessage() string

GetWelcomeMessage returns the value of the welcome message.

func (*Service) Halt ¶

func (s *Service) Halt()

func (*Service) Metrics ¶

func (s *Service) Metrics() []prometheus.Collector

func (*Service) NATManager ¶

func (s *Service) NATManager() basichost.NATManager

func (*Service) NetworkStatus ¶

func (s *Service) NetworkStatus() p2p.NetworkStatus

NetworkStatus implements the p2p.NetworkStatuser interface.

func (*Service) NewStream ¶

func (s *Service) NewStream(ctx context.Context, overlay swarm.Address, headers p2p.Headers, protocolName, protocolVersion, streamName string) (p2p.Stream, error)

func (*Service) Peers ¶

func (s *Service) Peers() []p2p.Peer

func (*Service) Ping ¶

func (s *Service) Ping(ctx context.Context, addr ma.Multiaddr) (rtt time.Duration, err error)

func (*Service) Ready ¶

func (s *Service) Ready() error

func (*Service) SetPickyNotifier ¶

func (s *Service) SetPickyNotifier(n p2p.PickyNotifier)

func (*Service) SetWelcomeMessage ¶

func (s *Service) SetWelcomeMessage(val string) error

SetWelcomeMessage sets the welcome message for the handshake protocol.

func (*Service) StatusMetrics ¶ added in v2.6.0

func (s *Service) StatusMetrics() []prometheus.Collector

StatusMetrics exposes metrics that are exposed on the status protocol.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
blocklist
breaker
handshake
handshake/mock
handshake/pb Package pb holds only Protocol Buffer definitions and generated code.	Package pb holds only Protocol Buffer definitions and generated code.
headers/pb Package pb holds only Protocol Buffer definitions and generated code.	Package pb holds only Protocol Buffer definitions and generated code.
reacher Package reacher runs a background worker that will ping peers from an internal queue and report back the reachability to the notifier.	Package reacher runs a background worker that will ping peers from an internal queue and report back the reachability to the notifier.
mock

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