Skip to content

Commit 92c72f0

Browse files
committed
docs: add recommended naming section to rpc spec
1 parent e71a2e4 commit 92c72f0

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

RPC_SPEC.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,18 @@ to v1 packets. This is because:
180180

181181
These behaviors are the same for v1 and v2.
182182

183+
### Recommended Naming
184+
In existing implementations of this proposal, the entity responsible for the **caller** role(s) in the
185+
above workflow is called `RpcClientManager`. The entity responsible for the **handler** role(s) in
186+
the above workflow is called `RpcServerManager`.
187+
188+
Store client protocol versions in constants named `CLIENT_PROTOCOL_DEFAULT` for `0`, and
189+
`CLIENT_PROTOCOL_DATA_STREAM_RPC` for `1`.
190+
191+
Use these names unless it would be burdensome to do so due to past sdk architecture decisions - if
192+
you don't use these names, please provide a rationale to the user and make sure they agree before
193+
continuing.
194+
183195
## Minimum required test cases
184196

185197
The following tests represent the minimum set that must pass for a conforming implementation. They

0 commit comments

Comments
 (0)