Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. Comms
  5. pw_rpc2
  6. Status
  7. pw::rpc2::RpcStatus Class Reference
Public Member Functions | Static Public Member Functions | List of all members
pw::rpc2::RpcStatus Class Referencefinal
Comms » pw_rpc2 » Status

Overview

The status returned by pw_rpc2 APIs. Wraps an RpcCode. Use RpcStatus objects instead of raw RpcCode values.

Inheritance diagram for pw::rpc2::RpcStatus:
pw::StatusBase< RpcStatus, RpcCode::kOk >

Public Member Functions

constexpr RpcStatus (Code code)
 
constexpr bool IsEndOfStream () const
 
constexpr bool IsCancelled () const
 
constexpr bool IsClosed () const
 
constexpr bool IsWriteClosed () const
 
constexpr bool IsDisconnected () const
 
constexpr bool IsResourceExhausted () const
 
constexpr bool IsUnavailable () const
 
constexpr bool IsAborted () const
 
constexpr bool IsUnimplemented () const
 
constexpr bool IsMessageTooLarge () const
 
constexpr bool IsDataError () const
 
constexpr bool IsProtocolError () const
 
- Public Member Functions inherited from pw::StatusBase< RpcStatus, RpcCode::kOk >
constexpr bool ok () const noexcept
 Returns true if the status is the OK code.
 
constexpr Code code () const noexcept
 Returns the underlying status code.
 
constexpr void Update (RpcStatus other) noexcept
 
constexpr void IgnoreError () const noexcept
 Ignores any errors, suppressing unused-result warnings.
 
constexpr const char * str () const
 

Static Public Member Functions

static constexpr RpcStatus EndOfStream ()
 
static constexpr RpcStatus Cancelled ()
 
static constexpr RpcStatus Closed ()
 
static constexpr RpcStatus WriteClosed ()
 
static constexpr RpcStatus Disconnected ()
 
static constexpr RpcStatus ResourceExhausted ()
 
static constexpr RpcStatus Unavailable ()
 
static constexpr RpcStatus Aborted ()
 
static constexpr RpcStatus Unimplemented ()
 
static constexpr RpcStatus MessageTooLarge ()
 
static constexpr RpcStatus DataError ()
 
static constexpr RpcStatus ProtocolError ()
 

Additional Inherited Members

- Public Types inherited from pw::StatusBase< RpcStatus, RpcCode::kOk >
using Code = decltype(kOkCode)
 The underlying status code type.
 
- Protected Member Functions inherited from pw::StatusBase< RpcStatus, RpcCode::kOk >
constexpr StatusBase () noexcept
 Defaults to kOkCode (ok() == true).
 
constexpr StatusBase (Code code) noexcept
 Explicitly construct from the underlying code.
 
constexpr StatusBase (const StatusBase &)=default
 
constexpr StatusBase (StatusBase &&)=default
 
constexpr StatusBase & operator= (const StatusBase &)=default
 
constexpr StatusBase & operator= (StatusBase &&)=default
 
- Protected Attributes inherited from pw::StatusBase< RpcStatus, RpcCode::kOk >
Code code_
 
The documentation for this class was generated from the following file: