B2BITS FIX Antenna C++  2.27.1
Public Member Functions | Protected Attributes | List of all members
Engine::Error Class Reference

Represents error event. More...

#include <B2BITS_Event.h>

+ Inheritance diagram for Engine::Error:
+ Collaboration diagram for Engine::Error:

Public Member Functions

 Error (const std::string &msg)
 Constructor. More...
 
virtual Type getType () const
 Returns the event type. More...
 
virtual const std::string * what () const
 Describes the event. More...
 
virtual ~Error ()
 Destructor. More...
 

Protected Attributes

std::string m_reason
 Contains std::string that describes the event. More...
 

Additional Inherited Members

- Public Types inherited from Engine::Event
enum  Type {
  EVENT, ERROR_EVENT, NOTIFICATION, WARNING,
  SESSION_ERROR, SESSION_LOGON_ERROR, PARSE_ERROR_IN_SESSION, NEW_INCOMING_CONNECTION,
  NEW_INCOMING_CONNECTION_ERROR, SESSION_NOTIFICATION, SESSION_WAS_REJECTED, SESSION_WAS_CREATED,
  SESSION_WAS_CONNECTED, SESSION_WAS_CLOSED, SESSION_WAS_ESTABLISHED, SESSION_WAS_RESTORED,
  SYNCHRONIZATION_COMPLETE, SESSION_WARNING, LINK_ERROR_WAS_DETECTED, LINK_WAS_RESTORED,
  PERSISTENT_DATA_WERE_FOUND, DEBUG_MESSAGE, SESSION_DEBUG_MESSAGE
}
 Event types. More...
 
- Protected Member Functions inherited from Engine::Event
virtual ~Event ()
 Destructor. More...
 

Detailed Description

Represents error event.

See also
NotificationsMgr

Constructor & Destructor Documentation

◆ Error()

Engine::Error::Error ( const std::string &  msg)

Constructor.

Parameters
msgstd::string that describes the event.

◆ ~Error()

virtual Engine::Error::~Error ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ getType()

virtual Type Engine::Error::getType ( ) const
inlinevirtual

Returns the event type.

Can be used instead of C++ RTTI.

Implements Engine::Event.

Reimplemented in Engine::ParseErrorInSession, Engine::SessionLogonError, Engine::SessionError, and Engine::NewIncomingConnectionError.

References Engine::Event::ERROR_EVENT.

◆ what()

virtual const std::string* Engine::Error::what ( ) const
virtual

Describes the event.

Implements Engine::Event.

Reimplemented in Engine::SessionLogonError, and Engine::SessionError.

Member Data Documentation

◆ m_reason

std::string Engine::Error::m_reason
protected

Contains std::string that describes the event.