LibMqMsgque_tcl.h

Go to the documentation of this file.

 
#pragma once
 
#include "LibMkKernel_tcl.h"
#include "LibMqMsgque_mq.h"
#include "tmpl/mq_type_S_lng.h"
 
/*****************************************************************************/
/*                                                                           */
/*                              Macro_API                                    */
/*                                                                           */
/*****************************************************************************/
 
// BEGIN-HEADER - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
#undef HEADER
#define HEADER
 
// If the source of libmqmsgque is direct used in an external library
// (without dynamic linking) and this library should *not* export
// the symbol's of libmqmsgque then the flag META_IGNORE_EXTERN have
// to be set
#undef MQ_TCL_EXTERN
#if defined(META_IGNORE_EXTERN)
#   define MQ_TCL_EXTERN
#elif defined(PIC)
   // does we build a DLL ?
#  if defined(DLL_EXPORT)
       // does we build the libmqmsgque library ?
#      if defined(MQ_TCL_BUILD_DLL)
#        define MQ_TCL_EXTERN __declspec(dllexport)
#      else
#        define MQ_TCL_EXTERN __declspec(dllimport)
#      endif
#  else
   // no DLL - architecture specific extern specifier
#    define MQ_TCL_EXTERN __attribute__ ((visibility("default")))
#  endif
#else
#   define MQ_TCL_EXTERN
#endif
 
// external data lookup
#undef MQ_TCL_EXTERN_DATA
#if defined(META_PRIVATE)
#  define MQ_TCL_EXTERN_DATA extern
#elif defined(META_IGNORE_EXTERN)
#  define MQ_TCL_EXTERN_DATA extern
#elif defined(PIC)
   // does we build a DLL ?
#  if defined(DLL_EXPORT)
       // does we build the libmqmsgque library ?
#      if defined(MQ_TCL_BUILD_DLL)
#        define MQ_TCL_EXTERN_DATA __declspec(dllexport)
#      else
#        define MQ_TCL_EXTERN_DATA __declspec(dllimport)
#      endif
#  else
   // no DLL - architecture specific extern specifier
#    define MQ_TCL_EXTERN_DATA __attribute__ ((visibility("default"))) extern
#  endif
#else
#  define MQ_TCL_EXTERN_DATA extern
#endif
 
#undef MQ
#define MQ(n) tclmqmsgque_ ## n
#undef NS
#define NS(n) tclmqmsgque_ ## n
 
// END-HEADER - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
// BEGIN-Class-def - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
#define MqContextC_ARGS      OBJECT_ARGS
#define MqContextC_ARGS_CALL OBJECT_ARGS_CALL
#define MqDumpC_ARGS         OBJECT_ARGS
#define MqDumpC_ARGS_CALL    OBJECT_ARGS_CALL
#define MqFactoryC_ARGS      OBJECT_ARGS
#define MqFactoryC_ARGS_CALL OBJECT_ARGS_CALL
 
// END-Class-def - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
/*****************************************************************************/
/*                                                                           */
/*                                  check                                    */
/*                                                                           */
/*****************************************************************************/
 
#include "tmpl/mq_misc_check_lng.h"
 
/*****************************************************************************/
/*                                                                           */
/*                                  Class_API                                */
/*                                                                           */
/*****************************************************************************/
 
// BEGIN-CLASS - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
// ----------------------------------------------------------------------
// class: MqContextC
 
  #define MqContextC_lngO MQ(MqContextC)
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_CLS_T MQ(MqContextC);
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_OBJ_T MQ(MqContextC_MK_NULL);
 
  int MQ(pMqContextC_Init) (MK_RT_ARGS OT_ENV_T, OT_NS_T );
 
  #define OT_retObj_SET_CTX(nat) retObj = MQ(MqContextC_ObjNew) (MK_RT_CALL interp,nat)
 
  #define OT_TMP_CTX_OBJ(val) MQ(MqContextC_ObjNew) (MK_RT_CALL interp,val)
 
  MK_ARTIFICIAL
  mk_inline OT_OBJ_T MQ(MqContextC_ObjNew) (MK_RT_ARGS OT_ENV_T interp, MqContextC_type hdl) {
    return ( hdl ? MK(AtomObjNew) (MK_RT_CALL interp, MqContextC_X2obj(hdl)) : MQ(MqContextC_MK_NULL) );
  }
 
// ----------------------------------------------------------------------
// class: MqDumpC
 
  #define MqDumpC_lngO MQ(MqDumpC)
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_CLS_T MQ(MqDumpC);
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_OBJ_T MQ(MqDumpC_MK_NULL);
 
  int MQ(pMqDumpC_Init) (MK_RT_ARGS OT_ENV_T, OT_NS_T );
 
  #define OT_retObj_SET_DMP(nat) retObj = MQ(MqDumpC_ObjNew) (MK_RT_CALL interp,nat)
 
  #define OT_TMP_DMP_OBJ(val) MQ(MqDumpC_ObjNew) (MK_RT_CALL interp,val)
 
  MK_ARTIFICIAL
  mk_inline OT_OBJ_T MQ(MqDumpC_ObjNew) (MK_RT_ARGS OT_ENV_T interp, MqDumpC_type hdl) {
    return ( hdl ? MK(AtomObjNew) (MK_RT_CALL interp, MqDumpC_X2obj(hdl)) : MQ(MqDumpC_MK_NULL) );
  }
 
// ----------------------------------------------------------------------
// class: MqFactoryC
 
  #define MqFactoryC_lngO MQ(MqFactoryC)
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_CLS_T MQ(MqFactoryC);
  MQ_TCL_EXTERN_DATA MkThreadLocal OT_OBJ_T MQ(MqFactoryC_MK_NULL);
 
  int MQ(pMqFactoryC_Init) (MK_RT_ARGS OT_ENV_T, OT_NS_T );
 
  #define OT_retObj_SET_FCT(nat) retObj = MQ(MqFactoryC_ObjNew) (MK_RT_CALL interp,nat)
 
  #define OT_TMP_FCT_OBJ(val) MQ(MqFactoryC_ObjNew) (MK_RT_CALL interp,val)
 
  MK_ARTIFICIAL
  mk_inline OT_OBJ_T MQ(MqFactoryC_ObjNew) (MK_RT_ARGS OT_ENV_T interp, MqFactoryC_type hdl) {
    return ( hdl ? MK(AtomObjNew) (MK_RT_CALL interp, MqFactoryC_X2obj(hdl)) : MQ(MqFactoryC_MK_NULL) );
  }
 
// END-CLASS - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
/*****************************************************************************/
/*                                                                           */
/*                                  types                                    */
/*                                                                           */
/*****************************************************************************/
 
// \brief object to link the \libmqmsgque object with application specific data
//
// extra attributes: objectMy staticMy - both are cashes
struct TclContextS {
  struct MqContextS mqctx;  
  OT_OBJ_T my;              
};
 
/*****************************************************************************/
/*                                                                           */
/*                                 functions                                 */
/*                                                                           */
/*****************************************************************************/
 
// from MqContextC_tcl.c
 
int NS(MqContextC_ReadLIST)       (MqContextC_ARGS);
int NS(MqContextC_ReadNEXT)       (MqContextC_ARGS);
 
// from MqCall_tcl.c
 
void          MK_DECL NS(ServiceFree)      ( MQ_SERVICE_FREE_ARGS );
void          MK_DECL NS(ServiceCopy)      ( MQ_SERVICE_COPY_ARGS );
enum MkErrorE MK_DECL NS(ServiceCall)      ( MQ_SERVICE_CALL_ARGS );
 
// from MqFactoryC.c
int       NS(MqFactoryC_Setup)          ( MK_RT_ARGS OT_ENV_T );
 
/*****************************************************************************/
/*                                                                           */
/*                                 enum                                      */
/*                                                                           */
/*****************************************************************************/
 
// BEGIN-enum - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
MQ_TCL_EXTERN int MK_DECL MQ(Get_MqIdentE_FromObj)(MK_RT_ARGS OT_ENV_T interp, OT_OBJ_T enumE, enum MqIdentE *ret);
#define Get_MqIdentE_FromObj_path MQ(Get_MqIdentE_FromObj)
 
MQ_TCL_EXTERN int MK_DECL MQ(Get_MqSlaveE_FromObj)(MK_RT_ARGS OT_ENV_T interp, OT_OBJ_T enumE, enum MqSlaveE *ret);
#define Get_MqSlaveE_FromObj_path MQ(Get_MqSlaveE_FromObj)
 
MQ_TCL_EXTERN int MK_DECL MQ(Get_MqStartE_FromObj)(MK_RT_ARGS OT_ENV_T interp, OT_OBJ_T enumE, enum MqStartE *ret);
#define Get_MqStartE_FromObj_path MQ(Get_MqStartE_FromObj)
 
MQ_TCL_EXTERN int MK_DECL MQ(Get_MqStatusIsEF_FromObj)(MK_RT_ARGS OT_ENV_T interp, OT_OBJ_T enumE, enum MqStatusIsEF *ret);
#define Get_MqStatusIsEF_FromObj_path MQ(Get_MqStatusIsEF_FromObj)
 
MQ_TCL_EXTERN int MK_DECL MQ(Get_MqWaitOnEventE_FromObj)(MK_RT_ARGS OT_ENV_T interp, OT_OBJ_T enumE, enum MqWaitOnEventE *ret);
#define Get_MqWaitOnEventE_FromObj_path MQ(Get_MqWaitOnEventE_FromObj)
 
// END-enum - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
// BEGIN-enum-tostring - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
#define OT_NEW_Mq_enum_OBJ(typ,val)  MQ(Mq ## typ ## _ToString(val))
 
MQ_TCL_EXTERN OT_OBJ_T MK_DECL MQ(MqIdentE_ToString) (const enum MqIdentE);
 
MQ_TCL_EXTERN OT_OBJ_T MK_DECL MQ(MqSlaveE_ToString) (const enum MqSlaveE);
 
MQ_TCL_EXTERN OT_OBJ_T MK_DECL MQ(MqStartE_ToString) (const enum MqStartE);
 
MQ_TCL_EXTERN OT_OBJ_T MK_DECL MQ(MqStatusIsEF_ToString) (const enum MqStatusIsEF);
 
MQ_TCL_EXTERN OT_OBJ_T MK_DECL MQ(MqWaitOnEventE_ToString) (const enum MqWaitOnEventE);
 
// END-enum-tostring - created by 'tcl_MqS.tcl -i NHI1_HOME/theLink/c/gen/c_mqmsgque.meta' - DO NOT change
 
/*****************************************************************************/
/*                                                                           */
/*                          inline functions                                 */
/*                                                                           */
/*****************************************************************************/
 
#undef HEADER