mirror of https://gitee.com/bigwinds/arangodb
115 lines
4.5 KiB
C
115 lines
4.5 KiB
C
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief error handling
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
|
|
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
///
|
|
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Dr. Frank Celler
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2011-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_BASICS_C_ERROR_H
|
|
#define ARANGODB_BASICS_C_ERROR_H 1
|
|
|
|
#ifndef TRI_WITHIN_COMMON
|
|
#error use <Basics/Common.h>
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public types
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief error code/message container
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
typedef struct TRI_error_s {
|
|
int _code;
|
|
char* _message;
|
|
}
|
|
TRI_error_t;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the last error
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int TRI_errno (void);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the last error as string
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char const* TRI_last_error (void);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief sets the last error
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int TRI_set_errno (int);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief defines an error string
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_set_errno_string (int, char const*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief return an error message for an error code
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char const* TRI_errno_string (int);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- MODULE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initialises the error messages
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_InitialiseError (void);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief shuts down the error messages
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_ShutdownError (void);
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|