client

Jun 23, 2024

Changes in this version

type Client

+ BandwidthByProtocol func(ctx context.Context) (api.BandwidthByProtocol, error)

Oct 12, 2023

Changes in this version

type Client

+ Health func(ctx context.Context) error

Jul 6, 2022

Changes in this version

type Client

+ func NewLBClient(strategy LBStrategy, cfgs []*Config, retries int) (Client, error)

+ Alerts func(ctx context.Context) ([]api.Alert, error)

+ MetricNames func(ctx context.Context) ([]string, error)

+ RepoGC func(ctx context.Context, local bool) (api.GlobalRepoGC, error)

+ StatusCids func(ctx context.Context, cids []api.Cid, local bool, out chan<- api.GlobalPinInfo) error

type Config

+ func (c *Config) AsTemplateFor(addrs []ma.Multiaddr) []*Config

+ func (c *Config) AsTemplateForResolvedAddress(ctx context.Context, addr ma.Multiaddr) ([]*Config, error)

+ type Failover struct

+ func (f *Failover) Next(count int) Client

+ func (f *Failover) SetClients(cl []Client)

+ type LBStrategy interface

+ Next func(count int) Client

+ SetClients func(clients []Client)

+ type RoundRobin struct

+ func (r *RoundRobin) Next(count int) Client

+ func (r *RoundRobin) SetClients(cl []Client)

type StatusFilterParams

+ Limit int

Mar 7, 2019

Changes in this version

type Client

+ PinPath func(ctx context.Context, path string, opts api.PinOptions) (*api.Pin, error)

+ UnpinPath func(ctx context.Context, path string) (*api.Pin, error)

Nov 1, 2018

Changes in this version

type Client

+ Metrics func(name string) ([]api.Metric, error)

Oct 3, 2018

Changes in this version

+ func WaitFor(ctx context.Context, c Client, fp StatusFilterParams) (api.GlobalPinInfo, error)

type Client

+ func NewDefaultClient(cfg *Config) (Client, error)

Aug 24, 2018

Changes in this version

+ var DefaultPort = 9094

+ var ResolveTimeout = 30 * time.Second

+ func IsPeerAddress(addr ma.Multiaddr) bool

type Client

+ func (c *Client) Add(paths []string, params *api.AddParams, out chan<- *api.AddedOutput) error

+ func (c *Client) AddMultiFile(multiFileR *files.MultiFileReader, params *api.AddParams, ...) error

Mar 29, 2018

Changes in this version

+ var DefaultProxyPort = 9095

type Client

+ func (c *Client) IPFS() *shell.Shell

+ func (c *Client) WaitFor(ctx context.Context, fp StatusFilterParams) (api.GlobalPinInfo, error)

type Config

+ PeerAddr ma.Multiaddr

+ ProtectorKey []byte

+ ProxyAddr ma.Multiaddr

+ type StatusFilterParams struct

+ CheckFreq time.Duration

+ Cid *cid.Cid

+ Local bool

+ Target api.TrackerStatus

Feb 12, 2018

Changes in this version

type Client

+ func (c *Client) GetConnectGraph() (api.ConnectGraphSerial, error)

Dec 11, 2017

Changes in this version

+ var DefaultAPIAddr = "/ip4/127.0.0.1/tcp/9094"

+ var DefaultLogLevel = "info"

+ var DefaultTimeout = 60 * time.Second

+ type Client struct

+ func NewClient(cfg *Config) (*Client, error)

+ func (c *Client) Allocation(ci *cid.Cid) (api.Pin, error)

+ func (c *Client) Allocations() ([]api.Pin, error)

+ func (c *Client) ID() (api.ID, error)

+ func (c *Client) PeerAdd(addr ma.Multiaddr) (api.ID, error)

+ func (c *Client) PeerRm(id peer.ID) error

+ func (c *Client) Peers() ([]api.ID, error)

+ func (c *Client) Pin(ci *cid.Cid, replicationFactor int, name string) error

+ func (c *Client) Recover(ci *cid.Cid, local bool) (api.GlobalPinInfo, error)

+ func (c *Client) RecoverAll(local bool) ([]api.GlobalPinInfo, error)

+ func (c *Client) Status(ci *cid.Cid, local bool) (api.GlobalPinInfo, error)

+ func (c *Client) StatusAll(local bool) ([]api.GlobalPinInfo, error)

+ func (c *Client) Sync(ci *cid.Cid, local bool) (api.GlobalPinInfo, error)

+ func (c *Client) SyncAll(local bool) ([]api.GlobalPinInfo, error)

+ func (c *Client) Unpin(ci *cid.Cid) error

+ func (c *Client) Version() (api.Version, error)

+ type Config struct

+ APIAddr ma.Multiaddr

+ DisableKeepAlives bool

+ Host string

+ LogLevel string

+ NoVerifyCert bool

+ Password string

+ Port string

+ SSL bool

+ Timeout time.Duration

+ Username string