Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.10.0

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)

v0.10.0-rc1

Mar 4, 2019

v0.9.0

Feb 18, 2019

v0.9.0-rc1

Feb 12, 2019

v0.8.0

Jan 16, 2019

v0.8.0-rc1

Jan 14, 2019

v0.7.0

Nov 1, 2018

Changes in this version

type Client

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

v0.7.0-rc1

Oct 29, 2018

v0.6.0

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)

v0.6.0-rc1

Oct 1, 2018

v0.5.0

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

v0.5.0-rc1

Aug 21, 2018

v0.4.0

May 30, 2018

v0.4.0-rc2

May 28, 2018

v0.4.0-rc1

May 14, 2018

v0.3.5

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

v0.3.5-rc1

Mar 26, 2018

v0.3.4

Feb 20, 2018

v0.3.3

Feb 12, 2018

Changes in this version

type Client

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

v0.3.2

Jan 26, 2018

v0.3.1

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