CommunicationError.hpp

This File On Github
Ask A Question

API: latest
module: oatpp
#include "oatpp/web/protocol/CommunicationError.hpp"

CommunicationError

Communication Error

namespace oatpp { namespace web { namespace protocol { 
  class CommunicationError : public std::runtime_error {}
}}}

Methods

Return Type Name Summary
[none] CommunicationError Constructor.
oatpp::data::v_io_size getIOStatus Get I/O error. See oatpp::data::v_io_size.
oatpp::String& getMessage Get error message.

CommunicationError::CommunicationError

Constructor.

CommunicationError(oatpp::data::v_io_size ioStatus, const oatpp::String& message)

CommunicationError::getIOStatus

Get I/O error. See oatpp::data::v_io_size.

oatpp::data::v_io_size getIOStatus()

CommunicationError::getMessage

Get error message.

  • @return - error message.

oatpp::String& getMessage()

ProtocolErrorInfo

Protocol Error Info.

namespace oatpp { namespace web { namespace protocol { 
  template<class Status>
  struct ProtocolErrorInfo {}
}}}

Fields

Type Name Summary
oatpp::data::v_io_size ioStatus Get I/O level error.
Status status Configurable arbitrary data type.

Methods

Return Type Name Summary
[none] ProtocolErrorInfo Multiple implementations:
  1. Default Constructor.
  2. Constructor.

ProtocolErrorInfo::ioStatus

Get I/O level error.

oatpp::data::v_io_size ioStatus

ProtocolErrorInfo::status

Configurable arbitrary data type.

Status status

ProtocolErrorInfo::ProtocolErrorInfo

  1. Default Constructor.
    ProtocolErrorInfo()
      : ioStatus(0)
    
  2. Constructor.
    • @param pIOStatus - I/O level error. See oatpp::data::v_io_size.
    • @param pStatus - configurable arbitrary data type.
    ProtocolErrorInfo(oatpp::data::v_io_size pIOStatus, const Status& pStatus)
      : ioStatus(pIOStatus)
      , status(pStatus)
    

ProtocolError

Protocol Error template.

  • @tparam Status - arbitrary data type.

namespace oatpp { namespace web { namespace protocol { 
  template<class Status>
  class ProtocolError : public CommunicationError {}
}}}

Typedefs

Type Name Summary
ProtocolErrorInfo<Status> Info Cenvenience typedef for ProtocolErrorInfo

Methods

Return Type Name Summary
[none] ProtocolError Constructor.
Info getInfo Get error info.

ProtocolError::Info

Cenvenience typedef for ProtocolErrorInfo

typedef ProtocolErrorInfo<Status> Info

ProtocolError::ProtocolError

Constructor.

ProtocolError(const Info& info, const oatpp::String& message)
  : CommunicationError(info.ioStatus, message)
  , m_info(info)

ProtocolError::getInfo

Get error info.

  • @return - error info.

Info getInfo()

AsyncProtocolError

Protocol Error template.

  • @tparam Status - arbitrary data type.

namespace oatpp { namespace web { namespace protocol { 
  template<class Status>
  class AsyncProtocolError : public oatpp::data::AsyncIOError {}
}}}

Typedefs

Type Name Summary
ProtocolErrorInfo<Status> Info Cenvenience typedef for ProtocolErrorInfo

Methods

Return Type Name Summary
[none] AsyncProtocolError Constructor.
oatpp::String getMessage Error message.
Info getInfo Get error info.

AsyncProtocolError::Info

Cenvenience typedef for ProtocolErrorInfo

typedef ProtocolErrorInfo<Status> Info

AsyncProtocolError::AsyncProtocolError

Constructor.

AsyncProtocolError(const Info& info, const oatpp::String& message)
  : oatpp::data::AsyncIOError("AsyncProtocolError", info.ioStatus)
  , m_info(info)
  , m_message(message)

AsyncProtocolError::getMessage

Error message.

  • @return - error message.

oatpp::String getMessage()

AsyncProtocolError::getInfo

Get error info.

  • @return - error info.

Info getInfo()