FCPv2 GetRequestStatus

GetRequestStatus asks the Freenet node for the status of a single (get or put) request. The node will answer with a number of messages that depend on the status and parameters of the request.

When the Identifier is unknown, a ProtocolError with NO_SUCH_IDENTIFIER will be sent.

For get requests, the following messages may be sent:

• AllData, if the request’s return type is DIRECT.
• CompatibilityMode
• DataFound, if OnlyData is false and the request finished successfully.
• ExpectedHashes, if the hashes have already been determined.
• ExpectedMIME, if the MIME type has already been determined.
• ExpectedDataLength, if the length of the data has already been determined.
• GetFailed, if OnlyData is false and the request failed.
• PersistentGet, if OnlyData is false.
• ProtocolError with code WRONG_RETURN_TYPE, if OnlyData is true and the return type of the request is not * SendingToNetwork, if OnlyData is false, the verbosity mask of the request includes SENT_TO_NETWORK, and the request was sent to the network.
• SimpleProgress, if OnlyData is false and the request has not finished yet. DIRECT.

For put requests, the following message may be sent:

• ExpectedHashes, if the verbosity of the request includes EXPECTED_HASHES.
• FinishedCompression, if the verbosity of the request includes COMPRESSION_START_END.
• GeneratedMetadata, if the metadata has already been generated.
• PersistentPut or PersistentPutDir, depending on the request.
• PutFetchable, if the verbosity of the request includes PUT_FETCHABLE
• SimpleProgress, if the verbosity of the request includes SPLITFILE_PROGRESS.
• StartedCompression, if the verbosity of the request includes COMPRESSION_START_END.
• URIGenerated, if an URI has already been generated.

Note that the order the messages are sent in is not specified. Also, many of these messages are optional and cannot be relied upon to be sent under all circumstances.

Example

GetRequestStatus
Identifier=important-request-1
Global=true
OnlyData=false
EndMessage

Details

Field	Possible values	Mandatory	Default	Description
Identifier	any string	Yes	n/a	The identifier of the request to return the status for.
Global	[true, false]	No	false	If false, only requests of the current connection will be considered; otherwise, requests on the global queue will be considered as well.
OnlyData	[true, false]	No	false	If true, most status messages of a request with return type DIRECT will be skipped.