Documentation
¶
Overview ¶
Package ipfshttp implements an IPFS Cluster IPFSConnector component. It uses the IPFS HTTP API to communicate to IPFS.
Index ¶
- Variables
- type Connector
- func (ipfs *Connector) ConfigKey(keypath string) (interface{}, error)
- func (ipfs *Connector) ConnectSwarms() error
- func (ipfs *Connector) ID() (api.IPFSID, error)
- func (ipfs *Connector) Pin(hash *cid.Cid) error
- func (ipfs *Connector) PinLs(typeFilter string) (map[string]api.IPFSPinStatus, error)
- func (ipfs *Connector) PinLsCid(hash *cid.Cid) (api.IPFSPinStatus, error)
- func (ipfs *Connector) RepoSize() (int, error)
- func (ipfs *Connector) SetClient(c *rpc.Client)
- func (ipfs *Connector) Shutdown() error
- func (ipfs *Connector) Unpin(hash *cid.Cid) error
Constants ¶
This section is empty.
Variables ¶
var ( // maximum duration before timing out reading a full request IPFSProxyServerReadTimeout = 10 * time.Minute // maximum duration before timing out reading the headers of a request IPFSProxyServerReadHeaderTimeout = 5 * time.Second // maximum duration before timing out write of the response IPFSProxyServerWriteTimeout = 10 * time.Minute // server-side the amount of time a Keep-Alive connection will be // kept idle before being reused IPFSProxyServerIdleTimeout = 60 * time.Second )
IPFS Proxy settings
var ConnectSwarmsDelay = 7 * time.Second
ConnectSwarmsDelay specifies how long to wait after startup before attempting to open connections from this peer's IPFS daemon to the IPFS daemons of other peers.
Functions ¶
This section is empty.
Types ¶
type Connector ¶
type Connector struct {
// contains filtered or unexported fields
}
Connector implements the IPFSConnector interface and provides a component which does two tasks:
On one side, it proxies HTTP requests to the configured IPFS daemon. It is able to intercept these requests though, and perform extra operations on them.
On the other side, it is used to perform on-demand requests against the configured IPFS daemom (such as a pin request).
func NewConnector ¶
NewConnector creates the component and leaves it ready to be started
func (*Connector) ConfigKey ¶
ConfigKey fetches the IPFS daemon configuration and retrieves the value for a given configuration key. For example, "Datastore/StorageMax" will return the value for StorageMax in the Datastore configuration object.
func (*Connector) ConnectSwarms ¶
ConnectSwarms requests the ipfs addresses of other peers and triggers ipfs swarm connect requests
func (*Connector) ID ¶
ID performs an ID request against the configured IPFS daemon. It returns the fetched information. If the request fails, or the parsing fails, it returns an error and an empty IPFSID which also contains the error message.
func (*Connector) PinLs ¶
PinLs performs a "pin ls --type typeFilter" request against the configured IPFS daemon and returns a map of cid strings and their status.
func (*Connector) PinLsCid ¶
PinLsCid performs a "pin ls --type=recursive <hash> "request and returns an api.IPFSPinStatus for that hash.
func (*Connector) RepoSize ¶
RepoSize returns the current repository size of the ipfs daemon as provided by "repo stats". The value is in bytes.
Source Files