msgpack_rpc::common Namespace Reference

Namespace of common classes and functions. More...

Classes
class	MsgpackRPCException
	Class of exceptions in cpp-msgpack-rpc library. More...
class	Status
	Class of statuses. More...

Enumerations
enum class	StatusCode : std::uint8_t {   SUCCESS = 0 , INVALID_ARGUMENT , INVALID_MESSAGE , TYPE_ERROR ,   PRECONDITION_NOT_MET , OPERATION_ABORTED , OPERATION_FAILURE , HOST_UNRESOLVED ,   CONNECTION_FAILURE , TIMEOUT , SERVER_ERROR , UNEXPECTED_ERROR }
	Enumeration of status codes. More...

Functions
std::string_view	format_status_code (StatusCode code) noexcept
	Format a status code.

Detailed Description

Namespace of common classes and functions.

Enumeration Type Documentation

StatusCode

enum class msgpack_rpc::common::StatusCode : std::uint8_t

strong

Enumeration of status codes.

Enumerator
SUCCESS	Success.
INVALID_ARGUMENT	Invalid arguments in functions.
INVALID_MESSAGE	Failure in parsing a message.
TYPE_ERROR	Invalid types in a message.
PRECONDITION_NOT_MET	Pre-condition for a process is not met.
OPERATION_ABORTED	Operation was aborted by user.
OPERATION_FAILURE	Operation failed. (Mainly for OS calls.)
HOST_UNRESOLVED	Failure in resolving a host.
CONNECTION_FAILURE	Failure in connecting to an endpoint.
TIMEOUT	Timeout.
SERVER_ERROR	Error in servers.
UNEXPECTED_ERROR	Unexpected errors. (Maybe a bug.)

Definition at line 33 of file status_code.h.

Function Documentation

format_status_code()

std::string_view msgpack_rpc::common::format_status_code ( StatusCode code )

nodiscardnoexcept

Format a status code.

Parameters

[in]

code

Status code.

Returns

Formatted string.

Definition at line 25 of file status_code.cpp.