source/include/tpadm.h

0001 /**
0002  * @brief Enduro/X application server administration interface
0003  *
0004  * @file tpadm.h
0005  */
0006 /* -----------------------------------------------------------------------------
0007  * Enduro/X Middleware Platform for Distributed Transaction Processing
0008  * Copyright (C) 2009-2016, ATR Baltic, Ltd. All Rights Reserved.
0009  * Copyright (C) 2017-2023, Mavimax, Ltd. All Rights Reserved.
0010  * This software is released under one of the following licenses:
0011  * AGPL (with Java and Go exceptions) or Mavimax's license for commercial use.
0012  * See LICENSE file for full text.
0013  * -----------------------------------------------------------------------------
0014  * AGPL license:
0015  *
0016  * This program is free software; you can redistribute it and/or modify it under
0017  * the terms of the GNU Affero General Public License, version 3 as published
0018  * by the Free Software Foundation;
0019  *
0020  * This program is distributed in the hope that it will be useful, but WITHOUT ANY
0021  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
0022  * PARTICULAR PURPOSE. See the GNU Affero General Public License, version 3
0023  * for more details.
0024  *
0025  * You should have received a copy of the GNU Affero General Public License along
0026  * with this program; if not, write to the Free Software Foundation, Inc.,
0027  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0028  *
0029  * -----------------------------------------------------------------------------
0030  * A commercial use license is available from Mavimax, Ltd
0031  * contact@mavimax.com
0032  * -----------------------------------------------------------------------------
0033  */
0034
0035 #ifndef TPADM_H
0036 #define TPADM_H
0037
0038 #ifdef  __cplusplus
0039 extern "C" {
0040 #endif
0041
0042 /*---------------------------Includes-----------------------------------*/
0043 #include <Excompat.h>
0044 #include <ubf.h>
0045 /*---------------------------Externs------------------------------------*/
0046 /*---------------------------Macros-------------------------------------*/
0047 #define MIB_LOCAL   0x00001
0048
0049 /** Error codes for Admin API
0050  * @defgroup MIB_ERRORS MIB API error codes
0051  * @{
0052  */
0053 #define TAEAPP          -1   /**< Other componets failure                */
0054 #define TAECONFIG       -2   /**< Configuration file failure             */
0055 #define TAEINVAL        -3   /**< Invalid argument, see TA_BADFLD        */
0056 #define TAEOS           -4   /**< Operating system error, see TA_STATUS  */
0057 #define TAEPERM         -6   /**< No permissions for operation           */
0058 #define TAEPREIMAGE     -7   /**< Set failed due to invalid image        */
0059 #define TAEPROTO        -8   /**< Protocol error                         */
0060 #define TAEREQUIRED     -9   /**< Required field missing see TA_BADFLD   */
0061 #define TAESUPPORT      -10  /**< Admin call not support in current ver  */
0062 #define TAESYSTEM       -11  /**< System (Enduro/X) error occurred       */
0063 #define TAEUNIQ         -12  /**< Object for update not identified       */
0064 #define TAELIMIT        -13  /**< Cursor limit reached-wait for houskeep */
0065
0066 #define TAOK            0    /**< Request succeed, no up-updates         */
0067 #define TAUPDATED       1    /**< Succeed, updates made                  */
0068 #define TAPARTIAL       2    /**< Partial succeed, have updates          */
0069 /** @}*/
0070
0071 #define NDRX_TA_CLASS_CLIENT        "T_CLIENT"      /**<  Client process class */
0072 #define NDRX_TA_CLASS_DOMAIN        "T_DOMAIN"      /**<  Domain class         */
0073 #define NDRX_TA_CLASS_MACHINE       "T_MACHINE"     /**<  Machine class        */
0074 #define NDRX_TA_CLASS_QUEUE         "T_QUEUE"       /**<  Queue class          */
0075 #define NDRX_TA_CLASS_SERVER        "T_SERVER"      /**<  Server class         */
0076 #define NDRX_TA_CLASS_SERVICE       "T_SERVICE"     /**<  Service class        */
0077 #define NDRX_TA_CLASS_SVCGRP        "T_SVCGRP"      /**<  Service group        */
0078 #define NDRX_TA_CLASS_BRCON         "T_BRCON"       /**<  Bridge connection info*/
0079
0080 #define NDRX_TA_GET                 "GET"           /**< Get infos             */
0081 #define NDRX_TA_GETNEXT             "GETNEXT"       /**< Read next curs        */
0082
0083
0084 /*---------------------------Enums--------------------------------------*/
0085 /*---------------------------Typedefs-----------------------------------*/
0086 /*---------------------------Globals------------------------------------*/
0087 /*---------------------------Statics------------------------------------*/
0088 /*---------------------------Prototypes---------------------------------*/
0089 extern NDRX_API int tpadmcall(UBFH *inbuf, UBFH **outbuf, long flags);
0090
0091 #ifdef  __cplusplus
0092 }
0093 #endif
0094
0095 #endif  /* TPADM_H */
0096
0097 /* vim: set ts=4 sw=4 et smartindent: */