source/include/ubfutil.h

0001 /**
0002  * @brief ATMI Level UBF utilities
0003  *
0004  * @file ubfutil.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 #ifndef UBFUTIL_H
0035 #define UBFUTIL_H
0036
0037 #ifdef  __cplusplus
0038 extern "C" {
0039 #endif
0040 /*---------------------------Includes-----------------------------------*/
0041 #include <stdint.h>
0042
0043 #include "ubf.h"
0044 /*---------------------------Externs------------------------------------*/
0045 /*---------------------------Macros-------------------------------------*/
0046
0047 #define UBFUTIL_EXPORT      0x00000001  /* Export Field           */
0048 #define UBFUTIL_OPTIONAL    0x00000002  /* Field is opitional     */
0049
0050 /*---------------------------Enums--------------------------------------*/
0051 /*---------------------------Typedefs-----------------------------------*/
0052
0053 /**
0054  * map the c fields to UBF buffer and vice versa
0055  */
0056 typedef struct
0057 {
0058     BFLDID fld;         /* UBF buffer field                             */
0059     BFLDOCC occ;        /* UBF occurrence                               */
0060     size_t offset;      /* offset to data field (pointer arithmetics)   */
0061     BFLDLEN buf_size;   /* buffer size                                  */
0062     short ftype;        /* user field type                              */
0063 } ubf_c_map_t;
0064
0065 /*---------------------------Globals------------------------------------*/
0066 /*---------------------------Statics------------------------------------*/
0067 /*---------------------------Prototypes---------------------------------*/
0068
0069 extern NDRX_API int atmi_cvt_c_to_ubf(ubf_c_map_t *map, void *c_struct, UBFH *p_ub, long *rules);
0070 extern NDRX_API int atmi_cvt_ubf_to_c(ubf_c_map_t *map, UBFH *p_ub, void *c_struct, long *rules);
0071
0072 extern NDRX_API void ndrx_debug_dump_UBF(int lev, char *title, UBFH *p_ub);
0073 extern NDRX_API void ndrx_debug_dump_UBF_ubflogger(int lev, char *title, UBFH *p_ub);
0074 extern NDRX_API void ndrx_debug_dump_VIEW_ubflogger(int lev, char *title, char *cstruct, char *view);
0075 extern NDRX_API void ndrx_debug_dump_UBF_hdr_ubflogger(int lev, char *title, UBFH *p_ub);
0076
0077 extern NDRX_API long ndrx_Bneeded(BFLDOCC nrfields, BFLDLEN totsize);
0078
0079
0080 #ifdef  __cplusplus
0081 }
0082 #endif
0083
0084 #endif  /* UBFUTIL_H */
0085
0086 /* vim: set ts=4 sw=4 et smartindent: */