NdbError.hpp

/*
   Copyright (C) 2003-2006 MySQL AB, 2009 Sun Microsystems, Inc.
    All rights reserved. Use is subject to license terms.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

#ifndef NDB_ERROR_HPP
#define NDB_ERROR_HPP

#include "ndberror.h"

struct NdbError {
  enum Status {
    Success = ndberror_st_success,

    TemporaryError = ndberror_st_temporary,
    
    PermanentError = ndberror_st_permanent,
  
    UnknownResult = ndberror_st_unknown
  };
  
  enum Classification {
    NoError = ndberror_cl_none,

    ApplicationError = ndberror_cl_application,

    NoDataFound = ndberror_cl_no_data_found,

    ConstraintViolation = ndberror_cl_constraint_violation,

    SchemaError = ndberror_cl_schema_error,

    UserDefinedError = ndberror_cl_user_defined,
    
    InsufficientSpace = ndberror_cl_insufficient_space,

    TemporaryResourceError = ndberror_cl_temporary_resource,

    NodeRecoveryError = ndberror_cl_node_recovery,

    OverloadError = ndberror_cl_overload,

    TimeoutExpired = ndberror_cl_timeout_expired,
    
    UnknownResultError = ndberror_cl_unknown_result,
    
    InternalError = ndberror_cl_internal_error,

    FunctionNotImplemented = ndberror_cl_function_not_implemented,

    UnknownErrorCode = ndberror_cl_unknown_error_code,

    NodeShutdown = ndberror_cl_node_shutdown,

    SchemaObjectExists = ndberror_cl_schema_object_already_exists,

    InternalTemporary = ndberror_cl_internal_temporary
  };
  
  Status status;

  Classification classification;
  
  int code;

  int mysql_code;

  const char * message;

#ifndef DOXYGEN_SHOULD_SKIP_DEPRECATED

  char * details;
#endif

#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
  NdbError(){
    status = UnknownResult;
    classification = NoError;
    code = 0;
    mysql_code = 0;
    message = 0;
    details = 0;
  }
  NdbError(const ndberror_struct & ndberror){
    status = (NdbError::Status) ndberror.status;
    classification = (NdbError::Classification) ndberror.classification;
    code = ndberror.code;
    mysql_code = ndberror.mysql_code;
    message = ndberror.message;
    details = ndberror.details;
  }
  operator ndberror_struct() const {
    ndberror_struct ndberror;
    ndberror.status = (ndberror_status_enum) status;
    ndberror.classification = (ndberror_classification_enum) classification;
    ndberror.code = code;
    ndberror.mysql_code = mysql_code;
    ndberror.message = message;
    ndberror.details = details;
    return ndberror;
  }
#endif
};

class NdbOut& operator <<(class NdbOut&, const NdbError &);
class NdbOut& operator <<(class NdbOut&, const NdbError::Status&);
class NdbOut& operator <<(class NdbOut&, const NdbError::Classification&);
#endif