GNE  0.75.0
Public Member Functions | List of all members
GNE::LowLevelError Class Reference
Mid-Level API

Adds low level HawkNL and possibly system error information to any other error. More...

#include <Errors.h>

Inheritance diagram for GNE::LowLevelError:
GNE::Error

Public Member Functions

 LowLevelError (ErrorCode newCode=OtherLowLevelError)
 Creates a normal error, but picks up any error information reported currently by the underlying network library implementation.
virtual std::string toString () const
 Returns a string description of this error.
- Public Member Functions inherited from GNE::Error
 Error (ErrorCode ec=NoError)
 Create a new object representing a certain error, given by the passed ErrorCode.
ErrorCode getCode () const
 Returns the error code for this error.
const void setCode (ErrorCode newCode)
 Sets the error code for this error, useful after a call to createLowLevelError() to specify a more appropriate high-level error code.
 operator bool () const
 Returns getCode() != NoError, a handy shortcut so you can test for error by if (error).
bool operator== (const ErrorCode &rhs) const
 A handy shortcut for (error.getCode() == rhs).

Additional Inherited Members

- Public Types inherited from GNE::Error
enum  ErrorCode {
  NoError = 0, ProtocolViolation, GNETheirVersionLow, GNETheirVersionHigh,
  WrongGame, UserVersionMismatch, CouldNotOpenSocket, ConnectionTimeOut,
  ConnectionAborted, ConnectionRefused, ConnectionDropped, SyncConnectionReleased,
  ExitNoticeReceived, Read, Write, UnknownPacket,
  PacketTypeMismatch, DuplicateObjectId, UnknownObjectId, InvalidObjectPacket,
  InvalidCreationPacketType, BufferUnderflow, BufferOverflow, InvalidBufferPosition,
  InvalidBufferLimit, OtherGNELevelError, OtherLowLevelError, User
}
 An enum describing connection failure type. More...

Detailed Description

Adds low level HawkNL and possibly system error information to any other error.

Member Function Documentation

std::string GNE::LowLevelError::toString ( ) const
virtual

Returns a string description of this error.

When possible, the string is "programmer-friendly," so you will probably want to only use this to write a debug message or out to a log, and tell the user more about the error.

Reimplemented from GNE::Error.

The documentation for this class was generated from the following files: