Overview

Status codes and result types for RPC operations

Classes
class	pw::rpc2::RpcStatus

Typedefs
template<typename T >
using	pw::rpc2::RpcResult = ::pw::Result< T, RpcStatus >
	A value of type `T`, or the `RpcStatus` explaining why there is none.

Enumerations
enum class	pw::rpc2::internal::ProtocolError : uint8_t { ProtocolError::kNone = 0 , ProtocolError::kInternal = 1 , ProtocolError::kCancelled = 2 , ProtocolError::kMethodTypeMismatch = 3 , ProtocolError::kReceivedPacketForWrongEndpoint = 4 , ProtocolError::kReceivedPacketForUnknownCall = 5 , ProtocolError::kUnknownService = 64 , ProtocolError::kUnknownMethod = 65 , ProtocolError::kReceivedDuplicateStart = 66 , ProtocolError::kInvalidRequestPayload = 67 , ProtocolError::kFailedToAllocateCall = 68 , ProtocolError::kFailedToAllocateCallResourcesWhileRunning = 69 , ProtocolError::kServiceUnregistered = 70 , ProtocolError::kDroppedWithoutResponse = 71 , ProtocolError::kMethodReturnedWithoutFinishing = 72 }

enum class	pw::rpc2::RpcCode : uint8_t { RpcCode::kOk = 0 , RpcCode::kEndOfStream = 1 , RpcCode::kCancelled = 2 , RpcCode::kClosed = 3 , RpcCode::kWriteClosed = 4 , RpcCode::kDisconnected = 5 , RpcCode::kResourceExhausted = 6 , RpcCode::kUnavailable = 7 , RpcCode::kAborted = 8 , RpcCode::kUnimplemented = 9 , RpcCode::kMessageTooLarge = 10 , RpcCode::kDataError = 11 , RpcCode::kProtocolError = 12 }

Enumeration Type Documentation

◆ ProtocolError

enum class pw::rpc2::internal::ProtocolError : uint8_t

strong

The 8-bit error code carried by an ERROR_TERMINAL packet.

Every code names exactly one condition, so the peer knows precisely why a call ended. ProtocolError is internal: no public API takes or returns one.

The top two bits of each code are its origin, which determines which endpoint may send it:

0x00–0x3F: Either endpoint (except kNone, which is never sent).
0x40–0x7F: Server only.
0x80–0xBF: Client only (none are defined).
0xC0–0xFF: Reserved.

These are the codes for protocol version 1. Endpoints shall only send error codes known to the negotiated version. Receivers shall treat unrecognized codes as a protocol violation.

Enumerator
kNone	No error. Never sent over the wire. Used by implementations when there is no error to send.
kInternal	A bug in the RPC implementation.
kCancelled	Application code cancelled the call. The cancellation may be explicit, with a function call, or implicit, by dropping a call handle before the call completes.
kMethodTypeMismatch	A packet does not match the method's type. On the server, a unary or server-streaming call must be started by a packet that carries the request message and closes the client's stream. On the client, a unary or client-streaming call must be answered by a single packet that carries the response message and terminates the RPC.
kReceivedPacketForWrongEndpoint	The endpoint received a packet type that only its own role may send (a server received a server-to-client packet, or a client received a client-to-server packet).
kReceivedPacketForUnknownCall	The endpoint received a non-terminal packet for a call ID it does not know about.
kUnknownService	The requested service is not registered on the server.
kUnknownMethod	The requested method is not registered on the target service.
kReceivedDuplicateStart	The server received a start packet for a call ID that is still active. Both calls end.
kInvalidRequestPayload	The request payload could not be decoded.
kFailedToAllocateCall	The server could not allocate state for the call. The method never ran.
kFailedToAllocateCallResourcesWhileRunning	An allocation failed after the method started.
kServiceUnregistered	The service was unregistered while the call was running. The C++ server does not support unregistering services, so it never sends this.
kDroppedWithoutResponse	A call handle was destroyed without responding or cancelling.
kMethodReturnedWithoutFinishing	The method completed while handles to it were still open.

◆ RpcCode

enum class pw::rpc2::RpcCode : uint8_t

strong

The outcome of a pw_rpc2 operation, expressed as what the caller should do next.

Each code maps to one distinct action, so the code alone is enough to decide how to respond. The precise cause of an error is not part of the status: pw_rpc2 logs it where it is detected.

These codes are never sent on the wire. Endpoints exchange more precise error codes, which the receiver converts to one of these. The numeric values may change.

Enumerator
kOk	The operation succeeded. Action: Continue.
kEndOfStream	The peer finished its stream and every message it sent has been read. Not a failure. For a client, the RPC finished successfully. Action: Stop reading.
kCancelled	Application code on either side ended the call, explicitly (with `Cancel()`) or implicitly (for example, by dropping a call handle). Action: Stop work on the call. Don't retry automatically: application logic chose to end it.
kClosed	You closed the `Client` or `Server`, or the object you used is empty. Action: Up to you; you closed this call.
kWriteClosed	This call's outbound direction is closed. The call itself may still be open. Action: Stop writing. If a response or more messages are expected, keep reading.
kDisconnected	The connection is gone or could not be made, for a reason that a new connection can fix. Whether the peer processed in-flight calls is unknown. Action: Create a new `Client`, with backoff. Retry in-flight calls only if they are idempotent. On a server, stop work on the call.
kResourceExhausted	This endpoint could not allocate memory for the operation. The peer was not involved. Action: Free local resources (finish or drop other calls, or run fewer at once), then retry. Backing off against the server won't help.
kUnavailable	The server could not take the call right now. The method never ran. Action: Retry later with backoff. Retrying is safe even for methods that are not idempotent.
kAborted	The server started the call, then ended it for a reason outside the method's control. The method may have partly run. Action: Retry only if the method is idempotent; otherwise, report the failure.
kUnimplemented	The server does not offer this method in the form the client expects. Action: Don't retry against this server. Fall back (for example, to an older API or a feature-detected path), or fix the deployment or schema mismatch.
kMessageTooLarge	An outbound message is larger than the transport or reservation allows. Nothing was sent, and the call is still open. Action: Send a smaller message (for example, split it), or raise the reservation or transport limit.
kDataError	A message could not be encoded or decoded. Action: Don't resend the same message unchanged; fix it or the schema mismatch. What remains of the call depends on where the error occurred: Local write: nothing was sent, and the call is still open. Local read: that one message is dropped. A stream stays open, and the next read may succeed. The server could not decode the request: the call is over.
kProtocolError	An endpoint broke the protocol, the endpoints' protocol versions are incompatible, or an RPC implementation has a bug. If the error closed the connection, later calls on the same `Client` also report `PROTOCOL_ERROR`. Action: Nothing fixes this at runtime: reconnecting and retrying won't help. Log or report it; it needs a code or deployment fix.

Overview

Classes

Typedefs

Enumerations

Enumeration Type Documentation

◆ ProtocolError

◆ RpcCode