bee

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2020 License: BSD-3-Clause Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// MaxChunkSize represents max chunk size in bytes
	MaxChunkSize = 4096
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Addresses added in v0.2.3 

type Addresses struct {
	Overlay   swarm.Address
	Underlay  []string
	Ethereum  string
	PublicKey string
}

Addresses represents node's addresses

type AddressesStreamMsg added in v0.2.3 

type AddressesStreamMsg struct {
	Name      string
	Addresses Addresses
	Error     error
}

AddressesStreamMsg represents message sent over the AddressStream channel

type Balance added in v0.2.20 

type Balance struct {
	Balance int
	Peer    string
}

Balance represents node's balance with peer

type Balances added in v0.2.20 

type Balances struct {
	Balances []Balance
}

Balances represents Balances's response

type BalancesStreamMsg added in v0.2.20 

type BalancesStreamMsg struct {
	Name     string
	Balances Balances
	Error    error
}

BalancesStreamMsg represents message sent over the BalancesStream channel

type Bin added in v0.2.2 

type Bin struct {
	Connected         int
	ConnectedPeers    []swarm.Address
	DisconnectedPeers []swarm.Address
	Population        int
}

Bin represents Kademlia bin

type Chunk 

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

Chunk represents Bee chunk

func NewChunk 

func NewChunk(data []byte) (Chunk, error)

NewChunk returns new chunk

func NewRandomChunk 

func NewRandomChunk(r *rand.Rand) (Chunk, error)

NewRandomChunk returns new pseudorandom chunk

func (*Chunk) Address 

func (c *Chunk) Address() swarm.Address

Address returns chunk's address

func (*Chunk) ClosestNode 

func (c *Chunk) ClosestNode(nodes []swarm.Address) (closest swarm.Address, err error)

ClosestNode returns chunk's closest node of a given set of nodes

func (*Chunk) ClosestNodeFromMap added in v0.4.0 

func (c *Chunk) ClosestNodeFromMap(nodes map[string]swarm.Address) (closestName string, closestAddress swarm.Address, err error)

ClosestNodeFromMap returns chunk's closest node of a given map of nodes

func (*Chunk) Data 

func (c *Chunk) Data() []byte

Data returns chunk's data

func (*Chunk) SetAddress added in v0.2.17 

func (c *Chunk) SetAddress() error

SetAddress calculates the address of a chunk and assign's it to address field

func (*Chunk) Size 

func (c *Chunk) Size() int

Size returns chunk size

func (*Chunk) Span added in v0.2.7 

func (c *Chunk) Span() int

Span returns chunk span

type Client added in v0.4.0 

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

Client manages communication with the Bee node

func NewClient added in v0.4.0 

func NewClient(opts ClientOptions) (c *Client)

NewClient returns Bee client

func (*Client) Addresses added in v0.4.0 

func (c *Client) Addresses(ctx context.Context) (resp Addresses, err error)

Addresses returns node's addresses

func (*Client) Balance added in v0.4.0 

func (c *Client) Balance(ctx context.Context, a swarm.Address) (resp Balance, err error)

Balance returns node's balance with a given peer

func (*Client) Balances added in v0.4.0 

func (c *Client) Balances(ctx context.Context) (resp Balances, err error)

Balances returns node's balances

func (*Client) CreateTag added in v0.4.0 

func (c *Client) CreateTag(ctx context.Context) (resp api.TagResponse, err error)

CreateTag creates tag on the node

func (*Client) DownloadBytes added in v0.4.0 

func (c *Client) DownloadBytes(ctx context.Context, a swarm.Address) (data []byte, err error)

DownloadBytes downloads chunk from the node

func (*Client) DownloadChunk added in v0.4.0 

func (c *Client) DownloadChunk(ctx context.Context, a swarm.Address, targets string) (data []byte, err error)

DownloadChunk downloads chunk from the node

func (*Client) DownloadFile added in v0.4.0 

func (c *Client) DownloadFile(ctx context.Context, a swarm.Address) (size int64, hash []byte, err error)

DownloadFile downloads chunk from the node and returns it's size and hash

func (*Client) DownloadManifestFile added in v0.4.0 

func (c *Client) DownloadManifestFile(ctx context.Context, a swarm.Address, path string) (size int64, hash []byte, err error)

DownloadManifestFile downloads manifest file from the node and returns it's size and hash

func (*Client) GetTag added in v0.4.0 

func (c *Client) GetTag(ctx context.Context, tagUID uint32) (resp api.TagResponse, err error)

GetTag retrieves tag from node

func (*Client) HasChunk added in v0.4.0 

func (c *Client) HasChunk(ctx context.Context, a swarm.Address) (bool, error)

HasChunk returns true/false if node has a chunk

func (*Client) Overlay added in v0.4.0 

func (c *Client) Overlay(ctx context.Context) (swarm.Address, error)

Overlay returns node's overlay address

func (*Client) Peers added in v0.4.0 

func (c *Client) Peers(ctx context.Context) (peers []swarm.Address, err error)

Peers returns addresses of node's peers

func (*Client) PinChunk added in v0.4.0 

func (c *Client) PinChunk(ctx context.Context, a swarm.Address) (bool, error)

PinChunk returns true/false if chunk pinning is successful

func (*Client) Ping added in v0.4.0 

func (c *Client) Ping(ctx context.Context, node swarm.Address) (rtt string, err error)

Ping pings other node

func (*Client) PingStream added in v0.4.0 

func (c *Client) PingStream(ctx context.Context, nodes []swarm.Address) <-chan PingStreamMsg

PingStream returns stream of ping results for given nodes

func (*Client) PinnedChunk added in v0.4.0 

func (c *Client) PinnedChunk(ctx context.Context, a swarm.Address) (PinnedChunk, error)

PinnedChunk returns pinned chunk

func (*Client) PinnedChunks added in v0.4.0 

func (c *Client) PinnedChunks(ctx context.Context) (PinnedChunks, error)

PinnedChunks returns pinned chunks

func (*Client) RemoveChunk added in v0.4.0 

func (c *Client) RemoveChunk(ctx context.Context, chunk *Chunk) (err error)

RemoveChunk removes the given chunk from the node's local store

func (*Client) Settlement added in v0.4.0 

func (c *Client) Settlement(ctx context.Context, a swarm.Address) (resp Settlement, err error)

Settlement returns node's settlement with a given peer

func (*Client) Settlements added in v0.4.0 

func (c *Client) Settlements(ctx context.Context) (resp Settlements, err error)

Settlements returns node's settlements

func (*Client) Topology added in v0.4.0 

func (c *Client) Topology(ctx context.Context) (topology Topology, err error)

Topology returns Kademlia topology

func (*Client) Underlay added in v0.4.0 

func (c *Client) Underlay(ctx context.Context) ([]string, error)

Underlay returns node's underlay addresses

func (*Client) UnpinChunk added in v0.4.0 

func (c *Client) UnpinChunk(ctx context.Context, a swarm.Address) (bool, error)

UnpinChunk returns true/false if chunk unpinning is successful

func (*Client) UploadBytes added in v0.4.0 

func (c *Client) UploadBytes(ctx context.Context, b []byte, o api.UploadOptions) (swarm.Address, error)

UploadBytes uploads bytes to the node

func (*Client) UploadChunk added in v0.4.0 

func (c *Client) UploadChunk(ctx context.Context, chunk *Chunk, o api.UploadOptions) (err error)

UploadChunk uploads chunk to the node

func (*Client) UploadCollection added in v0.4.0 

func (c *Client) UploadCollection(ctx context.Context, f *File) (err error)

UploadCollection uploads TAR collection bytes to the node

func (*Client) UploadFile added in v0.4.0 

func (c *Client) UploadFile(ctx context.Context, f *File, pin bool) (err error)

UploadFile uploads file to the node

func (*Client) UploadFileWithTag added in v0.4.0 

func (c *Client) UploadFileWithTag(ctx context.Context, f *File, pin bool, tagUID uint32) (err error)

UploadFileWithTag uploads file with tag to the node

type ClientOptions added in v0.4.0 

type ClientOptions struct {
	APIURL              *url.URL
	APIInsecureTLS      bool
	DebugAPIURL         *url.URL
	DebugAPIInsecureTLS bool
}

ClientOptions holds optional parameters for the Client.

type Cluster 

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

Cluster represents cluster of Bee nodes

func NewCluster 

func NewCluster(name string, o ClusterOptions) *Cluster

NewCluster returns new cluster

func (*Cluster) AddNodeGroup added in v0.4.0 

func (c *Cluster) AddNodeGroup(name string, o NodeGroupOptions)

AddNodeGroup adds new node group to the cluster

func (*Cluster) Addresses added in v0.2.3 

func (c *Cluster) Addresses(ctx context.Context) (addrs map[string]NodeGroupAddresses, err error)

Addresses returns ClusterAddresses

func (*Cluster) Balances added in v0.2.20 

func (c *Cluster) Balances(ctx context.Context) (balances ClusterBalances, err error)

Balances returns ClusterBalances

func (*Cluster) GlobalReplicationFactor added in v0.2.12 

func (c *Cluster) GlobalReplicationFactor(ctx context.Context, a swarm.Address) (grf int, err error)

GlobalReplicationFactor returns the total number of nodes in the cluster that contain given chunk

func (*Cluster) Name added in v0.4.0 

func (c *Cluster) Name() string

Name returns name of the cluster

func (*Cluster) NodeGroup added in v0.4.0 

func (c *Cluster) NodeGroup(name string) *NodeGroup

NodeGroup returns node group

func (*Cluster) NodeGroups added in v0.4.0 

func (c *Cluster) NodeGroups() (l map[string]*NodeGroup)

NodeGroups returns map of node groups in the cluster

func (*Cluster) NodeGroupsSorted added in v0.4.0 

func (c *Cluster) NodeGroupsSorted() (l []string)

NodeGroupsSorted returns sorted list of node names in the node group

func (*Cluster) Overlays 

func (c *Cluster) Overlays(ctx context.Context) (overlays ClusterOverlays, err error)

Overlays returns ClusterOverlays

func (*Cluster) Peers added in v0.2.3 

func (c *Cluster) Peers(ctx context.Context) (peers ClusterPeers, err error)

Peers returns peers of all nodes in the cluster

func (*Cluster) Settlements added in v0.3.0 

func (c *Cluster) Settlements(ctx context.Context) (settlements ClusterSettlements, err error)

Settlements returns

func (*Cluster) Size 

func (c *Cluster) Size() (size int)

Size returns size of the cluster

func (*Cluster) Topologies added in v0.2.3 

func (c *Cluster) Topologies(ctx context.Context) (topologies ClusterTopologies, err error)

Topologies returns ClusterTopologies

type ClusterAddresses added in v0.4.0 

type ClusterAddresses map[string]NodeGroupAddresses

ClusterAddresses represents addresses of all nodes in the cluster

type ClusterBalances added in v0.4.0 

type ClusterBalances map[string]NodeGroupBalances

ClusterBalances represents balances of all nodes in the cluster

type ClusterOptions 

type ClusterOptions struct {
	Annotations         map[string]string
	APIDomain           string
	APIInsecureTLS      bool
	APIScheme           string
	DebugAPIDomain      string
	DebugAPIInsecureTLS bool
	DebugAPIScheme      string
	KubeconfigPath      string
	Labels              map[string]string
	Namespace           string
	DisableNamespace    bool
}

ClusterOptions represents Bee cluster options

type ClusterOverlays added in v0.4.0 

type ClusterOverlays map[string]NodeGroupOverlays

ClusterOverlays represents overlay addresses of all nodes in the cluster

type ClusterPeers added in v0.4.0 

type ClusterPeers map[string]NodeGroupPeers

ClusterPeers represents peers of all nodes in the cluster

type ClusterSettlements added in v0.4.0 

type ClusterSettlements map[string]NodeGroupSettlements

ClusterSettlements represents settlements of all nodes in the cluster

type ClusterTopologies added in v0.4.0 

type ClusterTopologies map[string]NodeGroupTopologies

ClusterTopologies represents Kademlia topology of all nodes in the cluster

type File added in v0.2.11 

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

File represents Bee file

func NewBufferFile added in v0.2.18 

func NewBufferFile(name string, buffer *bytes.Buffer) File

NewBufferFile returns new file with specified buffer

func NewRandomFile added in v0.2.11 

func NewRandomFile(r *rand.Rand, name string, size int64) File

NewRandomFile returns new pseudorandom file

func (*File) Address added in v0.2.11 

func (f *File) Address() swarm.Address

Address returns file's address

func (*File) CalculateHash added in v0.2.18 

func (f *File) CalculateHash() error

CalculateHash calculates hash from dataReader. It replaces dataReader with another that will contain the data.

func (*File) ClosestNode added in v0.2.11 

func (f *File) ClosestNode(nodes []swarm.Address) (closest swarm.Address, err error)

ClosestNode returns file's closest node of a given set of nodes

func (*File) DataReader added in v0.2.12 

func (f *File) DataReader() io.Reader

DataReader returns file's data reader

func (*File) Hash added in v0.2.12 

func (f *File) Hash() []byte

Hash returns file's hash

func (*File) Name added in v0.2.11 

func (f *File) Name() string

Name returns file's name

func (*File) Size added in v0.2.11 

func (f *File) Size() int64

Size returns file size

type HasChunkStreamMsg added in v0.2.12 

type HasChunkStreamMsg struct {
	Name  string
	Found bool
	Error error
}

HasChunkStreamMsg represents message sent over the HasChunkStream channel

type NodeGroup added in v0.4.0 

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

NodeGroup represents group of Bee nodes

func NewNodeGroup added in v0.4.0 

func NewNodeGroup(name string, o NodeGroupOptions) *NodeGroup

NewNodeGroup returns new node group

func (*NodeGroup) AddNode added in v0.4.0 

func (g *NodeGroup) AddNode(name string) (err error)

AddNode adss new node to the node group

func (*NodeGroup) Addresses added in v0.4.0 

func (g *NodeGroup) Addresses(ctx context.Context) (addrs NodeGroupAddresses, err error)

Addresses returns NodeGroupAddresses

func (*NodeGroup) AddressesStream added in v0.4.0 

func (g *NodeGroup) AddressesStream(ctx context.Context) <-chan AddressesStreamMsg

AddressesStream returns stream of addresses of all nodes in the node group

func (*NodeGroup) Balances added in v0.4.0 

func (g *NodeGroup) Balances(ctx context.Context) (balances NodeGroupBalances, err error)

Balances returns NodeGroupBalances

func (*NodeGroup) BalancesStream added in v0.4.0 

func (g *NodeGroup) BalancesStream(ctx context.Context) <-chan BalancesStreamMsg

BalancesStream returns stream of balances of all nodes in the cluster

func (*NodeGroup) GroupReplicationFactor added in v0.4.0 

func (g *NodeGroup) GroupReplicationFactor(ctx context.Context, a swarm.Address) (grf int, err error)

GroupReplicationFactor returns the total number of nodes in the node group that contain given chunk

func (*NodeGroup) HasChunkStream added in v0.4.0 

func (g *NodeGroup) HasChunkStream(ctx context.Context, a swarm.Address) <-chan HasChunkStreamMsg

HasChunkStream returns stream of HasChunk requests for all nodes in the node group

func (*NodeGroup) Name added in v0.4.0 

func (g *NodeGroup) Name() string

Name returns name of the node group

func (*NodeGroup) Node added in v0.4.0 

func (g *NodeGroup) Node(name string) *Client

Node returns node's client

func (*NodeGroup) Nodes added in v0.4.0 

func (g *NodeGroup) Nodes() (l map[string]*Client)

Nodes returns map of node groups in the node group

func (*NodeGroup) NodesSorted added in v0.4.0 

func (g *NodeGroup) NodesSorted() (l []string)

NodesSorted returns sorted list of node names in the node group

func (*NodeGroup) Overlays added in v0.4.0 

func (g *NodeGroup) Overlays(ctx context.Context) (overlays NodeGroupOverlays, err error)

Overlays returns NodeGroupOverlays

func (*NodeGroup) OverlaysStream added in v0.4.0 

func (g *NodeGroup) OverlaysStream(ctx context.Context) <-chan OverlaysStreamMsg

OverlaysStream returns stream of overlay addresses of all nodes in the node group TODO: add semaphore

func (*NodeGroup) Peers added in v0.4.0 

func (g *NodeGroup) Peers(ctx context.Context) (peers NodeGroupPeers, err error)

Peers returns NodeGroupPeers

func (*NodeGroup) PeersStream added in v0.4.0 

func (g *NodeGroup) PeersStream(ctx context.Context) <-chan PeersStreamMsg

PeersStream returns stream of peers of all nodes in the node group

func (*NodeGroup) RemoveNode added in v0.4.0 

func (g *NodeGroup) RemoveNode(name string)

RemoveNode removes node from the node group

func (*NodeGroup) Settlements added in v0.4.0 

func (g *NodeGroup) Settlements(ctx context.Context) (settlements NodeGroupSettlements, err error)

Settlements returns NodeGroupSettlements

func (*NodeGroup) SettlementsStream added in v0.4.0 

func (g *NodeGroup) SettlementsStream(ctx context.Context) <-chan SettlementsStreamMsg

SettlementsStream returns stream of settlements of all nodes in the cluster

func (*NodeGroup) Size added in v0.4.0 

func (g *NodeGroup) Size() int

Size returns size of the node group

func (*NodeGroup) StartNode added in v0.4.0 

func (g *NodeGroup) StartNode(ctx context.Context, o StartNodeOptions) (err error)

StartNode starts new node in the node group

func (*NodeGroup) Topologies added in v0.4.0 

func (g *NodeGroup) Topologies(ctx context.Context) (topologies NodeGroupTopologies, err error)

Topologies returns NodeGroupTopologies

func (*NodeGroup) TopologyStream added in v0.4.0 

func (g *NodeGroup) TopologyStream(ctx context.Context) <-chan TopologyStreamMsg

TopologyStream returns stream of peers of all nodes in the node group

type NodeGroupAddresses added in v0.4.0 

type NodeGroupAddresses map[string]Addresses

NodeGroupAddresses represents addresses of all nodes in the node group

type NodeGroupBalances added in v0.4.0 

type NodeGroupBalances map[string]map[string]int

NodeGroupBalances represents balances of all nodes in the node group

type NodeGroupOptions added in v0.4.0 

type NodeGroupOptions struct {
	Annotations               map[string]string
	ClefImage                 string
	ClefImagePullPolicy       string
	Image                     string
	ImagePullPolicy           string
	IngressAnnotations        map[string]string
	IngressDebugAnnotations   map[string]string
	Labels                    map[string]string
	LimitCPU                  string
	LimitMemory               string
	NodeSelector              map[string]string
	PersistenceEnabled        bool
	PersistenceStorageClass   string
	PersistanceStorageRequest string
	PodManagementPolicy       string
	RestartPolicy             string
	RequestCPU                string
	RequestMemory             string
	UpdateStrategy            string
}

NodeGroupOptions represents node group options

type NodeGroupOverlays added in v0.4.0 

type NodeGroupOverlays map[string]swarm.Address

NodeGroupOverlays represents overlay addresses of all nodes in the node group

type NodeGroupPeers added in v0.4.0 

type NodeGroupPeers map[string][]swarm.Address

NodeGroupPeers represents peers of all nodes in the node group

type NodeGroupSettlements added in v0.4.0 

type NodeGroupSettlements map[string]map[string]SentReceived

NodeGroupSettlements represents settlements of all nodes in the node group

type NodeGroupTopologies added in v0.4.0 

type NodeGroupTopologies map[string]Topology

NodeGroupTopologies represents Kademlia topology of all nodes in the node group

type OverlaysStreamMsg added in v0.2.3 

type OverlaysStreamMsg struct {
	Name    string
	Address swarm.Address
	Error   error
}

OverlaysStreamMsg represents message sent over the OverlaysStream channel

type PeersStreamMsg added in v0.2.3 

type PeersStreamMsg struct {
	Name  string
	Peers []swarm.Address
	Error error
}

PeersStreamMsg represents message sent over the PeersStream channel

type PingStreamMsg added in v0.2.4 

type PingStreamMsg struct {
	Node  swarm.Address
	RTT   string
	Index int
	Error error
}

PingStreamMsg represents message sent over the PingStream channel

type PinnedChunk added in v0.2.12 

type PinnedChunk struct {
	Address    swarm.Address
	PinCounter int
}

PinnedChunk represents pinned chunk

type PinnedChunks added in v0.2.12 

type PinnedChunks struct {
	Chunks []PinnedChunk
}

PinnedChunks represents pinned chunks

type SentReceived added in v0.3.0 

type SentReceived struct {
	Received int
	Sent     int
}

SentReceived object

type Settlement added in v0.3.0 

type Settlement struct {
	Peer     string
	Received int
	Sent     int
}

Settlement represents node's settlement with peer

type Settlements added in v0.3.0 

type Settlements struct {
	Settlements   []Settlement
	TotalReceived int
	TotalSent     int
}

Settlements represents Settlements's response

type SettlementsStreamMsg added in v0.3.0 

type SettlementsStreamMsg struct {
	Name        string
	Settlements Settlements
	Error       error
}

SettlementsStreamMsg represents message sent over the SettlementsStream channel

type StartNodeOptions added in v0.4.0 

type StartNodeOptions struct {
	Name         string
	Config       k8sBee.Config
	ClefKey      string
	ClefPassword string
	LibP2PKey    string
	SwarmKey     string
}

StartNodeOptions represents node start options

type Topology added in v0.2.2 

type Topology struct {
	Overlay        swarm.Address
	Connected      int
	Population     int
	NnLowWatermark int
	Depth          int
	Bins           map[string]Bin
}

Topology represents Kademlia topology

type TopologyStreamMsg added in v0.2.3 

type TopologyStreamMsg struct {
	Name     string
	Topology Topology
	Error    error
}

TopologyStreamMsg represents message sent over the TopologyStream channel

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.