# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
DEGRADED_PERFORMANCE indicates the system is currently under heavy load.
ERROR indicates that the system is currently experiencing an error and should not be used.
ONLINE indicates everything is working as expected.
PURGING indicates the system is undergoing data removal a purging system is not available for use unless all other nodes are unavailable.
BS_FORCE indicates to force the request regardless of any possible issues.
DEFAULT indicates to use the default settings.
BS_DELETE is used to delete a block from the store.
BS_GET is used to get a block from the store.
BS_GET_MANY is used to get many blocks from the store.
BS_PUT is used to put a single block in the store.
BS_PUT_MANY is used to put many blocks in the store.
DISCOVERY is a libp2p discovery service.
IDENTIFY is the identify service.
MDNS is used to discover libp2p hosts over mdns.
PUBSUB is the libp2p pubsub system.
GC_START is used to start gc.
GC_STATUS is used to retrieve gc status.
C_STOP is used to stop GC.
equivalent of ipfs p2p close.
equivalent of ipfs p2p forward.
equivalent of ipfs p2p listen.
equivalent of ipfs p2p ls.
No description provided by the author
No description provided by the author
REF_GET_COUNT is used to get the reference count of a particular cid.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AddLinksRequest is used to add links to an existing ipld node.
Blob is a chunk of binary data.
Block is a single block of ipfs data.
BlockstoreRequest is a message used to control blockstores.
BlockstoreResponse is a response to a BlockstoreqRequest.
ConnectRequest is used to connect to libp2p peers.
DagGetRequest is used to retrieve the raw data of an ipld dag node for the specified hash.
DagGetResponse is a response to DagGetRequest that returns the raw data of the matching ipld node.
DagPut allows us to store arbitrary bytes as a custom IPLD object.
DagPutResponse contains the hashes of ipld nodes generated by the dag put request.
DisableExtrasRequest is used to disable a particular extras feature.
DisconnectRequest is used to disconnect a connection to a libp2p peer.
DisconnectResponse is a response to a disconnect request.
StatusMessage is used to contain the status information about a particular disconnection attempt.
DownloadRequest is used to download a UnixFS object although it can in theory be used with other type of objects there may be some undefined behavior.
DownloadResponse contains the response to a download request which allows the gRPC server to stream blobs to the client.
Empty is an empty message.
EnableExtrasRequest is used to enable a particular extras feature.
GetLinksRequest is used to return all the links associated with a particular hash.
GetLinksResponse returns all the links for the associated hash that was requested.
GetPeersResponse is a response to GetPeers containing a slice of peer IDs.
An IPFS MerkleDAG Link.
An IPFS MerkleDAG Node.
IsConnectedRequest is used check whether or not we are currently peered with these peers.
IsConnectedResponse is a response to an IsConnectedRequest request.
KeystoreRequest is a message used in any keystore API request.
KeystoreResponse is a responsed to any keystore API request.
ManageGCRequest is a message used to control TemporalX garbage collection.
ManageGCResponse is a message used as a response to gc control requests.
NameSysPublishRequest is used to publish a value.
NameSysResolveRequest is used to resolve an IPNS name.
NameSysResolveRequest is an answer to a resolve request.
NewIPLDNodeRequest is used to create a new ipld node.
P2PLsInfo contains information about a single p2p stream.
P2PRequest is a request message holding the details of a particular P2P rpc call.
P2PResponse is a response message sent in response to a P2PRequest message.
PubSubListPeersRequest is used to return a list of peers that are subscribed to the given topic(s).
PubSubListPeersResponse is a response to a ListPeersRequest.
peer is a single peer.
PubSubMessageResposne is a received pubsub message sent as a response to a subscription rpc call.
PubSubPublishRequest is a message used to publish data to a topic.
PubSubSubscribeRequest is used to initiate a subscription to a given pubsub topic and stream received messages.
PubSubTopics is a response that returns the names of all known topics.
PutResponse is a response to any data storage (put) requests.
RefCountRequest is used to analyze the reference counter store, and retrieve usage information.
RefCountResponse is used to return the information gathered by a RefCount rpc call.
StatusResponse is used to return API status information.
UnimplementedAdminAPIServer can be embedded to have forward compatible implementations.
UnimplementedDagAPIServer can be embedded to have forward compatible implementations.
UnimplementedFileAPIServer can be embedded to have forward compatible implementations.
UnimplementedKeystoreAPIServer can be embedded to have forward compatible implementations.
UnimplementedNameSysAPIServer can be embedded to have forward compatible implementations.
UnimplementedNodeAPIServer can be embedded to have forward compatible implementations.
UnimplementedPubSubAPIServer can be embedded to have forward compatible implementations.
UnimplementedStatusAPIServer can be embedded to have forward compatible implementations.
UploadOptions allows controlling the parameters of a file upload.
UploadRequest is used to upload data as a UnixFS object.
VersionResponse is used to return API version information.
# Interfaces
AdminAPIClient is the client API for AdminAPI service.
AdminAPIServer is the server API for AdminAPI service.
DagAPIClient is the client API for DagAPI service.
DagAPIServer is the server API for DagAPI service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FileAPIClient is the client API for FileAPI service.
FileAPIServer is the server API for FileAPI service.
KeystoreAPIClient is the client API for KeystoreAPI service.
KeystoreAPIServer is the server API for KeystoreAPI service.
No description provided by the author
No description provided by the author
NameSysAPIClient is the client API for NameSysAPI service.
NameSysAPIServer is the server API for NameSysAPI service.
NodeAPIClient is the client API for NodeAPI service.
NodeAPIServer is the server API for NodeAPI service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PubSubAPIClient is the client API for PubSubAPI service.
PubSubAPIServer is the server API for PubSubAPI service.
StatusAPIClient is the client API for StatusAPI service.
StatusAPIServer is the server API for StatusAPI service.
# Type aliases
APISTATUS is an enum to return a concise description of api status.
BSREQOPTS are options for blockstore requests.
BSREQTYPE is a particular blockstore request type.
EXTRASTYPE denotes a particular extras type.
GCREQTYPE specifies the type of GC management call being performed.
P2PREQTYPE denotes the particular type of request being used in the p2p rpc.
REFREQOPTS are options for fine-tuning ref count requests.
REFREQTYPE is used to indicate the type of ref count request being made.