gzDistError.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistError.h
// Module       : gzDistribution
// Description  : Definition of a gzDistError interface
// Author       : Anders Sandblad
// Product      : GizmoDistribution 2.1.1
//      
// Copyright © 2004 - Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoDistribution is a toolkit used for implementing distributed 
//          objects and events in C++
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// XAA  031021  Created file    
//
//******************************************************************************
#ifndef __GZ_DIST_ERROR_H__
#define __GZ_DIST_ERROR_H__

// Includes
#include "gzDistBase.h"


//------------------------------ Error codes ----------------------------------

enum gzDistErrorCode
{
    GZ_DIST_NO_ERROR = 0,

    // Channel
    GZ_DIST_CHANNEL_MISSING,
    GZ_DIST_CHANNEL_ALREADY_OPEN,
    GZ_DIST_CHANNEL_NOT_OPEN,
    GZ_DIST_CHANNEL_MISSING_TRANSPORT,
    GZ_DIST_TRANSPORT_ALREADY_INSTALLED,

    // Protocol
    GZ_DIST_INVALID_PROTOCOL_VERSION,
    GZ_DIST_PROTOCOL_INCOMPLETE_MESSAGE,
    GZ_DIST_PROTOCOL_MESSAGE_TOO_LONG,
    GZ_DIST_PROTOCOL_SERIALIZE_WRITE_ERROR,
    GZ_DIST_PROTOCOL_PARSE_READ_ERROR,
    GZ_DIST_PROTOCOL_UNKNOWN_MESSAGE_CLASS,
    GZ_DIST_PROTOCOL_UNKNOWN_MESSAGE_TYPE,

    // Transport
    GZ_DIST_TRANSPORT_ALREADY_OPEN,
    GZ_DIST_TRANSPORT_ALREADY_CONNECTED,
    GZ_DIST_TRANSPORT_NOT_OPEN, 
    GZ_DIST_TRANSPORT_NOT_CONNECTED,    
    GZ_DIST_TRANSPORT_CONNECTION_FAILED,
    GZ_DIST_TRANSPORT_FAULTY_MESSAGE,
    GZ_DIST_TRANSPORT_WOULD_BLOCK,

    // Socket
    GZ_DIST_CREATE_SOCKET_FAILED,
    GZ_DIST_INVALID_SOCKET_OPTION,
    GZ_DIST_BIND_SOCKET_FAILED,
    GZ_DIST_SOCKET_SEND_FAILED,
    GZ_DIST_SOCKET_RECEIVE_FAILED,
    GZ_DIST_SOCKET_CONNECTION_REFUSED,
    GZ_DIST_SOCKET_CONNECTION_CLOSED,
    
    // Pipe
    GZ_DIST_WRITE_PIPE_FAILED,
    GZ_DIST_READ_PIPE_FAILED,

    // Client
    GZ_DIST_FAULTY_CLIENT,
    GZ_DIST_CLIENT_ALREADY_SUBSCRIBER,
    GZ_DIST_CLIENT_NOT_A_SUBSCRIBER,
    GZ_DIST_CLIENT_NOT_JOINED,
    GZ_DIST_CLIENT_ALREADY_EXIST,
    GZ_DIST_CLIENT_NOT_INITIALIZED,
    GZ_DIST_CLIENT_ALREADY_OWNER,
    GZ_DIST_UNHANDLED_CLIENT_MESSAGE,
    GZ_DIST_SESSION_NOT_FOUND,
    GZ_DIST_NO_MANAGER_EXIST,
    GZ_DIST_MANAGER_IS_NOT_RUNNING,
    GZ_DIST_MANAGER_IS_ALREADY_RUNNING,
    GZ_DIST_OBJECT_NOT_EVALUATED_FOR_SESSION,
    GZ_DIST_OBJECT_ALREADY_IN_SESSION,
    GZ_DIST_OBJECT_NOT_FOUND,
    GZ_DIST_OBJECT_NOT_IN_SESSION,
    GZ_DIST_ATTRIBUTE_NOT_FOUND,
    GZ_DIST_MESSAGE_TIMEOUT,
    GZ_DIST_OPTIMIZED_MEMORY_DISABLED,
    GZ_DIST_UNABLE_TO_ALLOCATE_MEMORY,
    GZ_DIST_EVENT_ALREADY_IN_SESSION,
    
    // Evaluator
    GZ_DIST_ILLEGAL_EVALUATOR,
    GZ_DIST_EVALUATOR_ALREADY_EXIST,
    GZ_DIST_OBJECT_REJECTED_BY_EVALUATOR,

    // Server
    GZ_DIST_SERVER_ENGINE_START_FAILED,
    GZ_DIST_SERVER_ENGINE_NOT_STARTED,
    GZ_DIST_SERVER_ALREADY_INSTALLED,
    GZ_DIST_SERVER_NOT_INSTALLED,
    GZ_DIST_SERVER_INSTALL_FAILED,
    GZ_DIST_SERVER_UNINSTALL_FAILED,

    // Common
    GZ_DIST_INVALID_PARAMETER,
    
    // TODO:
    // Add new error codes
    // Don't forget to add error string to the getErrorString() method

    GZ_DIST_UNKNOWN_ERROR
};


//------------------------------ Error levels ---------------------------------

enum gzDistErrorLevel
{
    GZ_DIST_ERROR_DEBUG = 0,        
    GZ_DIST_ERROR_NOTICE,           
    GZ_DIST_ERROR_WARNING,          
    GZ_DIST_ERROR_FATAL             
};


//------------------------------- gzDistError ----------------------------------

//******************************************************************************
// Class    : gzDistError
//                                  
// Purpose  : The base def class of a gzDistributionError.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// XAA  031021  Created 
//                                  
//******************************************************************************

class gzDistError
{
    public:


        GZ_DIST_EXPORT gzDistError();


        GZ_DIST_EXPORT gzDistError(const gzDistErrorCode& code, const gzDistErrorLevel& level);
        

        GZ_DIST_EXPORT gzDistError(const gzDistErrorCode& code, const gzDistErrorLevel& level, const gzString& additional);

        GZ_DIST_EXPORT gzDistError(const gzDistError& orig);

        GZ_DIST_EXPORT virtual ~gzDistError();
        
        GZ_DIST_EXPORT gzDistError& operator=(const gzDistError& rhs);
 

        GZ_DIST_EXPORT gzVoid setError(const gzDistErrorCode& code, const gzDistErrorLevel& level);


        GZ_DIST_EXPORT gzVoid setError(const gzDistErrorCode& code, const gzDistErrorLevel& level, const gzString& additional);
        
        GZ_DIST_EXPORT gzVoid resetError();

        GZ_DIST_EXPORT gzBool hasError() const;
        

        GZ_DIST_EXPORT operator gzBool() const;

        GZ_DIST_EXPORT gzDistErrorCode getErrorCode() const;

        GZ_DIST_EXPORT gzDistErrorLevel getErrorLevel() const;

        GZ_DIST_EXPORT gzBool operator==(const gzDistErrorCode& rhsCode) const;
        
        GZ_DIST_EXPORT gzBool operator!=(const gzDistErrorCode& rhsCode) const;

        GZ_DIST_EXPORT const gzString& getErrorString() const;
        
        GZ_DIST_EXPORT gzString getAdditionalString() const;

        GZ_DIST_EXPORT gzBool hasAdditionalString() const;
        
        GZ_DIST_EXPORT gzVoid reportError() const;
        
    private:

        // The error code
        gzDistErrorCode m_code : 16;

        // The error level
        gzDistErrorLevel m_level : 16;
        
        // Additional information string
        gzString* m_additional;
};


const gzDistError GZ_DIST_OK(GZ_DIST_NO_ERROR, GZ_DIST_ERROR_NOTICE);


//---------------------------- Global functions -------------------------------


GZ_DIST_EXPORT gzVoid gzDistReportLastError(gzBool clear = FALSE);



GZ_DIST_EXPORT gzDistError gzDistGetLastError(gzBool clear = FALSE);



GZ_DIST_EXPORT gzVoid gzDistSetLastError(const gzDistErrorCode& code, const gzDistErrorLevel& level);



GZ_DIST_EXPORT gzVoid gzDistSetLastError(const gzDistErrorCode& code, const gzDistErrorLevel& level, const gzString& additional);



GZ_DIST_EXPORT gzVoid gzDistSetLastError(const gzDistError& error);


GZ_DIST_EXPORT gzVoid gzDistClearLastError();



GZ_DIST_EXPORT gzVoid gzDistClearAllErrors();


#endif //__GZ_DIST_ERROR_H__

---