mirrors/arti.git/crates/arti-rpcserver/src/stream.rs, branch arti-v1.4.0mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=arti-v1.4.02025-01-30T18:28:11ZMerge branch 'rpc_document_internal_optimism' into 'main'2025-01-30T18:28:11ZNick Mathewsonnickm@torproject.org2025-01-30T18:28:11Zurn:sha1:f8d9cedfeecdb9bcdc7b006845c9856fed302f1f
rpc: Document what is actually going on with stream optimism.
Closes #1583
See merge request tpo/core/arti!2753proto: Rename (experimental) DataStream functions for ctrl access2025-01-30T16:11:01ZNick Mathewsonnickm@torproject.org2025-01-30T15:48:45Zurn:sha1:01197344045835a2e901cf68488332bf3c8ccd56
Since these return a client-specific type,
they need a client-specific name before we can stabilize them for RPC.
proto: Rename DataStreamCtrl to ClientDataStreamCtrl2025-01-30T16:11:01ZNick Mathewsonnickm@torproject.org2025-01-30T15:31:51Zurn:sha1:af6ba7ea0379e2129e1cef1952d193f6783c5bbb
The API for this type, and the fact that it implements
ClientStreamCtrl unconditionally, means that it is only for client
DataStreams.
rpc: Document what is actually going on with stream optimism.2025-01-30T14:55:26ZNick Mathewsonnickm@torproject.org2025-01-30T14:43:46Zurn:sha1:0feb61e046c08d022a3de3950f39397186414107
In brief: we _do_ correct implement correct optimistic vs
nonoptimistic behavior for RPC streams. Only our documentation was
wrong. Subsequent commits will fix our documentation more.
See #1583.
fix: fix typos2025-01-30T08:39:30ZDimitris Apostoloudimitris.apostolou@icloud.com2025-01-30T08:39:30Zurn:sha1:6371829c976f6a5b77d46bf977f369a915f2ced3rpc: Clean up documenation surrounding OneshotClient2025-01-15T20:02:13ZNick Mathewsonnickm@torproject.org2025-01-15T19:34:50Zurn:sha1:16b43efb1a9ab2085624d80e372b06ad0daa1633rpc: Rename new_stream_handle to new_oneshot_client.2025-01-15T19:44:32ZNick Mathewsonnickm@torproject.org2025-01-15T19:26:47Zurn:sha1:314d2c07bcfc6645debda810014e9439d7f11f2b
This method doesn't actually create a new stream; it creates a
single-use client object that can be used with SOCKS to launch
a new stream, and capture an RPC object for that stream.
Closes #1664.
rpcserver: Wrap InvokeError as internal error2024-10-17T19:19:40ZNick Mathewsonnickm@torproject.org2024-10-16T17:46:07Zurn:sha1:8e2bb09579f862c9b3ce5c4757d920c63f8745a9
I'm about to remove HasKind from InvokeError, which would otherwise
break this code.
These errors are all in fact internal errors, since in this context
they can only stem from incorrectly formed calls to
`invoke_special_method`.
Revise RPC documentation to be more informative.2024-10-02T13:41:24ZNick Mathewsonnickm@torproject.org2024-10-01T19:52:22Zurn:sha1:ce737947586f444ec104166394894386a9b48e43
Previous documentation was more-or-less meant for the Arti developer
only. This new documentation is intended for actual users of RPC
functionality. It's meant to be extracted with `maint/rpc-doc-tool`.
rpc: Rename SingletonId to SingleIdResponse2024-09-24T14:23:53ZNick Mathewsonnickm@torproject.org2024-09-24T14:21:17Zurn:sha1:bd9b29b05de6c133b93366acb69d9e2ce6b126cd
Calling it "singleton" might have suggested that it was using the
[singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern),
which it isn't.
(Renaming done with rust-analyzer and double-checked with `git grep`.)
Closes #1585.