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

rpc

package

Go to main page

Versions in this module

v0

v0.28.1

Sep 3, 2024

Changes in this version

type KeyAPI

+ func (api *KeyAPI) Sign(ctx context.Context, name string, data []byte) (iface.Key, []byte, error)

+ func (api *KeyAPI) Verify(ctx context.Context, keyOrName string, signature, data []byte) (iface.Key, bool, error)

type RoutingAPI

+ func (api *RoutingAPI) FindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo, error)

+ func (api *RoutingAPI) FindProviders(ctx context.Context, p path.Path, opts ...options.RoutingFindProvidersOption) (<-chan peer.AddrInfo, error)

+ func (api *RoutingAPI) Provide(ctx context.Context, p path.Path, opts ...options.RoutingProvideOption) error

v0.24.2

Aug 20, 2024

v0.24.1

Aug 20, 2024

v0.24.0

Aug 17, 2024

Changes in this version

+ const DefaultApiFile

+ const DefaultPathName

+ const DefaultPathRoot

+ const EnvDir

+ var ErrApiNotFound = errors.New("ipfs api address could not be found")

+ func ApiAddr(ipfspath string) (ma.Multiaddr, error)

+ type BlockAPI HttpApi

+ func (api *BlockAPI) Get(ctx context.Context, p path.Path) (io.Reader, error)

+ func (api *BlockAPI) Put(ctx context.Context, r io.Reader, opts ...caopts.BlockPutOption) (iface.BlockStat, error)

+ func (api *BlockAPI) Rm(ctx context.Context, p path.Path, opts ...caopts.BlockRmOption) error

+ func (api *BlockAPI) Stat(ctx context.Context, p path.Path) (iface.BlockStat, error)

+ type DhtAPI HttpApi

+ func (api *DhtAPI) FindPeer(ctx context.Context, p peer.ID) (peer.AddrInfo, error)

+ func (api *DhtAPI) FindProviders(ctx context.Context, p path.Path, opts ...caopts.DhtFindProvidersOption) (<-chan peer.AddrInfo, error)

+ func (api *DhtAPI) Provide(ctx context.Context, p path.Path, opts ...caopts.DhtProvideOption) error

+ type Error = cmds.Error

+ type HttpApi struct

+ Headers http.Header

+ func NewApi(a ma.Multiaddr) (*HttpApi, error)

+ func NewApiWithClient(a ma.Multiaddr, c *http.Client) (*HttpApi, error)

+ func NewLocalApi() (*HttpApi, error)

+ func NewPathApi(ipfspath string) (*HttpApi, error)

+ func NewURLApiWithClient(url string, c *http.Client) (*HttpApi, error)

+ func (api *HttpApi) Block() iface.BlockAPI

+ func (api *HttpApi) Dag() iface.APIDagService

+ func (api *HttpApi) Dht() iface.DhtAPI

+ func (api *HttpApi) Key() iface.KeyAPI

+ func (api *HttpApi) Name() iface.NameAPI

+ func (api *HttpApi) Object() iface.ObjectAPI

+ func (api *HttpApi) Pin() iface.PinAPI

+ func (api *HttpApi) PubSub() iface.PubSubAPI

+ func (api *HttpApi) Request(command string, args ...string) RequestBuilder

+ func (api *HttpApi) ResolveNode(ctx context.Context, p path.Path) (ipld.Node, error)

+ func (api *HttpApi) ResolvePath(ctx context.Context, p path.Path) (path.ImmutablePath, []string, error)

+ func (api *HttpApi) Routing() iface.RoutingAPI

+ func (api *HttpApi) Swarm() iface.SwarmAPI

+ func (api *HttpApi) Unixfs() iface.UnixfsAPI

+ func (api *HttpApi) WithOptions(opts ...caopts.ApiOption) (iface.CoreAPI, error)

+ type HttpDagServ httpNodeAdder

+ func (api *HttpDagServ) Add(ctx context.Context, nd format.Node) error

+ func (api *HttpDagServ) AddMany(ctx context.Context, nds []format.Node) error

+ func (api *HttpDagServ) Get(ctx context.Context, c cid.Cid) (format.Node, error)

+ func (api *HttpDagServ) GetMany(ctx context.Context, cids []cid.Cid) <-chan *format.NodeOption

+ func (api *HttpDagServ) Pinning() format.NodeAdder

+ func (api *HttpDagServ) Remove(ctx context.Context, c cid.Cid) error

+ func (api *HttpDagServ) RemoveMany(ctx context.Context, cids []cid.Cid) error

+ type KeyAPI HttpApi

+ func (api *KeyAPI) Generate(ctx context.Context, name string, opts ...caopts.KeyGenerateOption) (iface.Key, error)

+ func (api *KeyAPI) List(ctx context.Context) ([]iface.Key, error)

+ func (api *KeyAPI) Remove(ctx context.Context, name string) (iface.Key, error)

+ func (api *KeyAPI) Rename(ctx context.Context, oldName string, newName string, ...) (iface.Key, bool, error)

+ func (api *KeyAPI) Self(ctx context.Context) (iface.Key, error)

+ type NameAPI HttpApi

+ func (api *NameAPI) Publish(ctx context.Context, p path.Path, opts ...caopts.NamePublishOption) (ipns.Name, error)

+ func (api *NameAPI) Resolve(ctx context.Context, name string, opts ...caopts.NameResolveOption) (path.Path, error)

+ func (api *NameAPI) Search(ctx context.Context, name string, opts ...caopts.NameResolveOption) (<-chan iface.IpnsResult, error)

+ type ObjectAPI HttpApi

+ func (api *ObjectAPI) AddLink(ctx context.Context, base path.Path, name string, child path.Path, ...) (path.ImmutablePath, error)

+ func (api *ObjectAPI) AppendData(ctx context.Context, p path.Path, r io.Reader) (path.ImmutablePath, error)

+ func (api *ObjectAPI) Data(ctx context.Context, p path.Path) (io.Reader, error)

+ func (api *ObjectAPI) Diff(ctx context.Context, a path.Path, b path.Path) ([]iface.ObjectChange, error)

+ func (api *ObjectAPI) Get(ctx context.Context, p path.Path) (ipld.Node, error)

+ func (api *ObjectAPI) Links(ctx context.Context, p path.Path) ([]*ipld.Link, error)

+ func (api *ObjectAPI) New(ctx context.Context, opts ...caopts.ObjectNewOption) (ipld.Node, error)

+ func (api *ObjectAPI) Put(ctx context.Context, r io.Reader, opts ...caopts.ObjectPutOption) (path.ImmutablePath, error)

+ func (api *ObjectAPI) RmLink(ctx context.Context, base path.Path, link string) (path.ImmutablePath, error)

+ func (api *ObjectAPI) SetData(ctx context.Context, p path.Path, r io.Reader) (path.ImmutablePath, error)

+ func (api *ObjectAPI) Stat(ctx context.Context, p path.Path) (*iface.ObjectStat, error)

+ type PinAPI HttpApi

+ func (api *PinAPI) Add(ctx context.Context, p path.Path, opts ...caopts.PinAddOption) error

+ func (api *PinAPI) IsPinned(ctx context.Context, p path.Path, opts ...caopts.PinIsPinnedOption) (string, bool, error)

+ func (api *PinAPI) Ls(ctx context.Context, opts ...caopts.PinLsOption) (<-chan iface.Pin, error)

+ func (api *PinAPI) Rm(ctx context.Context, p path.Path, opts ...caopts.PinRmOption) error

+ func (api *PinAPI) Update(ctx context.Context, from path.Path, to path.Path, ...) error

+ func (api *PinAPI) Verify(ctx context.Context) (<-chan iface.PinStatus, error)

+ type PubsubAPI HttpApi

+ func (api *PubsubAPI) Ls(ctx context.Context) ([]string, error)

+ func (api *PubsubAPI) Peers(ctx context.Context, opts ...caopts.PubSubPeersOption) ([]peer.ID, error)

+ func (api *PubsubAPI) Publish(ctx context.Context, topic string, message []byte) error

+ func (api *PubsubAPI) Subscribe(ctx context.Context, topic string, opts ...caopts.PubSubSubscribeOption) (iface.PubSubSubscription, error)

+ type Request struct

+ ApiBase string

+ Args []string

+ Body io.Reader

+ Command string

+ Ctx context.Context

+ Headers map[string]string

+ Opts map[string]string

+ func NewRequest(ctx context.Context, url, command string, args ...string) *Request

+ func (r *Request) Send(c *http.Client) (*Response, error)

+ type RequestBuilder interface

+ Arguments func(args ...string) RequestBuilder

+ Body func(body io.Reader) RequestBuilder

+ BodyBytes func(body []byte) RequestBuilder

+ BodyString func(body string) RequestBuilder

+ Exec func(ctx context.Context, res interface{}) error

+ FileBody func(body io.Reader) RequestBuilder

+ Header func(name, value string) RequestBuilder

+ Option func(key string, value interface{}) RequestBuilder

+ Send func(ctx context.Context) (*Response, error)

+ type Response struct

+ Error *Error

+ Output io.ReadCloser

+ func (r *Response) Cancel() error

+ func (r *Response) Close() error

+ type RoutingAPI HttpApi

+ func (api *RoutingAPI) Get(ctx context.Context, key string) ([]byte, error)

+ func (api *RoutingAPI) Put(ctx context.Context, key string, value []byte, ...) error

+ type SwarmAPI HttpApi

+ func (api *SwarmAPI) Connect(ctx context.Context, pi peer.AddrInfo) error

+ func (api *SwarmAPI) Disconnect(ctx context.Context, addr multiaddr.Multiaddr) error

+ func (api *SwarmAPI) KnownAddrs(ctx context.Context) (map[peer.ID][]multiaddr.Multiaddr, error)

+ func (api *SwarmAPI) ListenAddrs(ctx context.Context) ([]multiaddr.Multiaddr, error)

+ func (api *SwarmAPI) LocalAddrs(ctx context.Context) ([]multiaddr.Multiaddr, error)

+ func (api *SwarmAPI) Peers(ctx context.Context) ([]iface.ConnectionInfo, error)

+ type UnixfsAPI HttpApi

+ func (api *UnixfsAPI) Add(ctx context.Context, f files.Node, opts ...caopts.UnixfsAddOption) (path.ImmutablePath, error)

+ func (api *UnixfsAPI) Get(ctx context.Context, p path.Path) (files.Node, error)

+ func (api *UnixfsAPI) Ls(ctx context.Context, p path.Path, opts ...caopts.UnixfsLsOption) (<-chan iface.DirEntry, error)