errors.h

Go to the documentation of this file.
00001 /*
00002  * errors.h
00003  *
00004  * Copyright (C) 2008,2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  * General error codes
00031  */
00032 
00033 #ifndef AESOP_INTERFACE_ERROR_H__
00034 #define AESOP_INTERFACE_ERROR_H__
00035 
00036 // includes --------------------------------------------------------------------
00037 #include "common/common.h"
00038 
00039 
00040 
00041 namespace aesop {
00042 
00043 /// \ingroup aesop_interface
00044 /*@{*/
00045 
00046 
00047 /// list of error codes that can appear in the Notify Error message
00048 enum eErrorCode {
00049         // general masks
00050         eErrorCode_Warn         = 0x10000, ///< informational or minor problem
00051         eErrorCode_Fail         = 0x20000, ///< something failed, maybe retry?
00052         eErrorCode_Fatal        = 0x40000, ///< client cannot proceed at all
00053 
00054         // fatal errors
00055         eErrorCode_BadProtocol  = 0x40001, ///< client/server protocol mismatch
00056         eErrorCode_BadStory     = 0x40002, ///< client/server story guid mismatch
00057 
00058         // keep this last!
00059         eErrorCode_OK           = 0x00000  ///< no problems
00060 };
00061 
00062 
00063 
00064 };      // aesop namespace
00065 
00066 
00067 #endif  // AESOP_INTERFACE_ERROR_H__
00068