rtfsc

package module

v0.11.0 Latest Latest Go to latest Published: Oct 3, 2019 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

rtfsc provides programmatic access to IPFS Cluster API's

Package rtfsc provides utility functions for interacting with IPFS cluster nodes and their restful api

This section is empty.

This section is empty.

This section is empty.

type ClusterManager struct {
	Config *client.Config
	Client client.Client
}

ClusterManager is a helper interface to interact with the cluster apis

func Initialize(ctx context.Context, hostAddress, hostPort string) (*ClusterManager, error)

Initialize is used to init, and return a cluster manager object

func (cm *ClusterManager) GenClient() error

GenClient is used to generate a client to interact with the cluster

func (cm *ClusterManager) GenRestAPIConfig()

GenRestAPIConfig is used to generate the api cfg needed to interact with the cluster

func (cm *ClusterManager) ListPeers(ctx context.Context) ([]*api.ID, error)

ListPeers is used to list the known cluster peers

func (cm *ClusterManager) Pin(ctx context.Context, cid gocid.Cid) (*api.Pin, error)

Pin is used to add a pin to the cluster