package swarm

import "github.com/ethersphere/swarm"

Index ¶

• type Info
• func (i *Info) Info() *Info
• type Swarm
• func NewSwarm(config *api.Config, mockStore *mock.NodeStore) (self *Swarm, err error)
• func (s *Swarm) APIs() []rpc.API
• func (s *Swarm) Protocols() (protos []p2p.Protocol)
• func (s *Swarm) RegisterPssProtocol(topic *pssmessage.Topic, spec *protocols.Spec, targetprotocol *p2p.Protocol, options *pss.ProtocolParams) (*pss.Protocol, error)
• func (s *Swarm) Start(srv *p2p.Server) error
• func (s *Swarm) Stop() error

Package Files ¶

swarm.go

type Info ¶ Uses

type Info struct {
    *api.Config
}

Info represents the current Swarm node's configuration

func (*Info) Info ¶ Uses

func (i *Info) Info() *Info

Info returns the current Swarm configuration

type Swarm ¶ Uses

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

Swarm abstracts the complete Swarm stack

func NewSwarm ¶ Uses

func NewSwarm(config *api.Config, mockStore *mock.NodeStore) (self *Swarm, err error)

NewSwarm creates a new swarm service instance implements node.Service If mockStore is not nil, it will be used as the storage for chunk data. MockStore should be used only for testing.

func (*Swarm) APIs ¶ Uses

func (s *Swarm) APIs() []rpc.API

APIs returns the RPC API descriptors the Swarm implementation offers implements node.Service

func (*Swarm) Protocols ¶ Uses

func (s *Swarm) Protocols() (protos []p2p.Protocol)

Protocols implements the node.Service interface

func (*Swarm) RegisterPssProtocol ¶ Uses

func (s *Swarm) RegisterPssProtocol(topic *pssmessage.Topic, spec *protocols.Spec, targetprotocol *p2p.Protocol, options *pss.ProtocolParams) (*pss.Protocol, error)

RegisterPssProtocol adds a devp2p protocol to the swarm node's Pss instance

func (*Swarm) Start ¶ Uses

func (s *Swarm) Start(srv *p2p.Server) error

Start is called when the stack is started * starts the network kademlia hive peer management * (starts netStore level 0 api) * starts DPA level 1 api (chunking -> store/retrieve requests) * (starts level 2 api) * starts http proxy server * registers url scheme handlers for bzz, etc * TODO: start subservices like sword, swear, swarmdns

implements the node.Service interface

func (*Swarm) Stop ¶ Uses

func (s *Swarm) Stop() error

Stop stops all component services. Implements the node.Service interface.

Directories ¶