diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2014-12-08 13:57:13 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2014-12-08 13:57:13 -0400 |
| commit | 28764ce2dc29d1d93989b4061b5b12bac10902de (patch) | |
| tree | 3b052b0785d387a86dfd9a14d8fd885f2d78d809 /doc | |
| parent | 335024d92294bd9504e9e9cd42ec0a4addfc4d69 (diff) | |
implement CLAIMURL for external special remote
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/design/external_special_remote_protocol.mdwn | 8 | ||||
| -rw-r--r-- | doc/todo/extensible_addurl.mdwn | 2 |
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn index 00533095c..332cc37b1 100644 --- a/doc/design/external_special_remote_protocol.mdwn +++ b/doc/design/external_special_remote_protocol.mdwn @@ -125,6 +125,10 @@ replying with `UNSUPPORTED-REQUEST` is acceptable. If the remote replies with `UNSUPPORTED-REQUEST`, its availability is assumed to be global. So, only remotes that are only reachable locally need to worry about implementing this. +* `CLAIMURL Value` + Asks the remote if it wishes to claim responsibility for downloading + an url. If so, the remote should send back an `CLAIMURL-SUCCESS` reply. + If not, it can send `CLAIMURL-FAILURE`. More optional requests may be added, without changing the protocol version, so if an unknown request is seen, reply with `UNSUPPORTED-REQUEST`. @@ -167,6 +171,10 @@ while it's handling a request. Indicates the INITREMOTE succeeded and the remote is ready to use. * `INITREMOTE-FAILURE ErrorMsg` Indicates that INITREMOTE failed. +* `CLAIMURL-SUCCESS` + Indicates that the CLAIMURL url will be handled by this remote. +* `CLAIMURL-FAILURE` + Indicates that the CLAIMURL url wil not be handled by this remote. * `UNSUPPORTED-REQUEST` Indicates that the special remote does not know how to handle a request. diff --git a/doc/todo/extensible_addurl.mdwn b/doc/todo/extensible_addurl.mdwn index 0db4085d1..e9a8d070a 100644 --- a/doc/todo/extensible_addurl.mdwn +++ b/doc/todo/extensible_addurl.mdwn @@ -22,7 +22,7 @@ both available from CERN and from a torrent, for example. Solution: Add a new method to remotes: - claimUrl :: Maybe (URLString -> IO Bool) + claimUrl :: Maybe (URLString -> Annex Bool) Remotes that implement this method (including special remotes) will be queried when such an uri is added, to see which claims it. Once the |