m2mb_os_q.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2MB_OS_Q_H
#define M2MB_OS_Q_H

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/


/* Global declarations ==========================================================================*/
#define  M2MB_OS_Q_INVALID           0
#define  M2MB_OS_Q_INVALID_ATTR      0
#define  M2MB_OS_Q_TX_PRIORITIZE     1
/* Global typedefs --------------------------------------------------------------- */

typedef enum
{
  M2MB_OS_Q_SEL_CMD_CREATE_ATTR,
  M2MB_OS_Q_SEL_CMD_DEL_ATTR,
  M2MB_OS_Q_SEL_CMD_NAME,                                       
  M2MB_OS_Q_SEL_CMD_USRNAME,                            
  M2MB_OS_Q_SEL_CMD_MSG_SIZE,                           
  M2MB_OS_Q_SEL_CMD_QSTART,                                     
  M2MB_OS_Q_SEL_CMD_QSIZE,                                      
  M2MB_OS_Q_SEL_CMD_SUSPENDED_COUNT,            
  M2MB_OS_Q_SEL_CMD_1ST_SUSP,                           
  M2MB_OS_Q_SEL_CMD_ENQUEUED,                           
  M2MB_OS_Q_SEL_CMD_QROOM,                                      
  /* ---- */
  M2MB_OS_Q_SEL_CMD_END,
  ENUM_TO_INT( M2MB_OS_Q_SEL_CMD_E )
} M2MB_OS_Q_SEL_CMD_E;

typedef HANDLE M2MB_OS_Q_HANDLE;
typedef HANDLE M2MB_OS_Q_ATTR_HANDLE;


/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_init( M2MB_OS_Q_HANDLE *pQHandle, M2MB_OS_Q_ATTR_HANDLE *pQAttrHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_deinit( M2MB_OS_Q_HANDLE qHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_rx( M2MB_OS_Q_HANDLE qHandle, void *pDest, UINT32 timeoutTicks );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_tx(
  M2MB_OS_Q_HANDLE qHandle,
  void *pSource,
  UINT32 timeoutTicks,
  UINT8 priority
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_hptf( M2MB_OS_Q_HANDLE queueHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_clear( M2MB_OS_Q_HANDLE qHandle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_setAttrItem( M2MB_OS_Q_ATTR_HANDLE *pQAttrHandle, UINT8 nCmds, ... );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_getItem(
  M2MB_OS_Q_HANDLE qHandle,
  M2MB_OS_Q_SEL_CMD_E selCmd,
  MEM_W *pOut,
  void *pIn
);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_os_q_setItem(
  M2MB_OS_Q_HANDLE qHandle,
  M2MB_OS_Q_SEL_CMD_E selCmd,
  void *pIn
);

/*-----------------------------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif /* M2MB_OS_H */