From 2c2c4da5e2014e8145f3268e60ac0cd18dff48e7 Mon Sep 17 00:00:00 2001 From: Striven <sg.striven@cutecat.club> Date: Tue, 09 Sep 2025 21:19:31 +0000 Subject: [PATCH] Add prologue notes for response packet --- 04_rendezvous/05_rmc_protocol.md | 19 ++++++++++++------- 1 files changed, 12 insertions(+), 7 deletions(-) diff --git a/04_rendezvous/05_rmc_protocol.md b/04_rendezvous/05_rmc_protocol.md index 08f5034..7f585a3 100644 --- a/04_rendezvous/05_rmc_protocol.md +++ b/04_rendezvous/05_rmc_protocol.md @@ -83,13 +83,18 @@ ### Successful Response Format -> [!NOTE] -> TODO: Document successful response +| Name | Description | Type | +|---------------|--------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| ... | See [Response Packet Format](#response-packet-format) for parsing the prologue of a successful response packet. | ... | +| Call ID | The nonce token for the call to associate the response to the request. | `u32` | +| Method Name | The method that was called by the client. | [`String`](./03_rendezvous_structure.md#string) | +| Response Data | Raw data to pass to the response handler, see the respective [protocol and method specification](#known-protocols) to write and read this. | `<remaining bytes>` | ### Unsuccessful Response Format -| Name | Description | Type | -|-----------------|------------------------------------------------------------------------|-------------------------------------------------| -| Error Namespace | The category of error that occurred. | [`String`](./03_rendezvous_structure.md#string) | -| Error Code | The code of the error in the specified namespace | `u16` | -| Call ID | The nonce token for the call to associate the response to the request. | `u32` | \ No newline at end of file +| Name | Description | Type | +|-----------------|--------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| ... | See [Response Packet Format](#response-packet-format) for parsing the prologue of an unsuccessful response packet. | ... | +| Error Namespace | The category of error that occurred. | [`String`](./03_rendezvous_structure.md#string) | +| Error Code | The code of the error in the specified namespace | `u16` | +| Call ID | The nonce token for the call to associate the response to the request. | `u32` | \ No newline at end of file -- Gitblit v1.10.0