Home > Support > Documentation

rtxContext.h File Reference

Common run-time context definitions. More...

#include "rtxsrc/rtxDList.h"

Go to the source code of this file.


Classes

struct  OSRTErrLocn
 Run-time error location structure. More...
struct  OSRTErrInfo
 Run-time error information structure. More...
struct  OSRTErrInfoList
struct  OSRTBuffer
 Run-time message buffer structure. More...
struct  OSRTBufSave
 Structure to save the current message buffer state. More...
struct  OSCTXT

Defines

#define OSRTENCBUFSIZ   16*1024
#define OSRTERRSTKSIZ   8
#define OSRTMAXERRPRM   5
#define OSDIAG   0x80000000
#define OSTRACE   0x40000000
#define OSDISSTRM   0x20000000
#define OSSAVEBUF   0x10000000
#define OSNOSTRMBACKOFF   0x8000000
#define OSRT_GET_FIRST_ERROR_INFO(pctxt)
#define OSRT_GET_LAST_ERROR_INFO(pctxt)
#define OSRTISSTREAM(pctxt)   ((pctxt)->pStream != 0 && !((pctxt)->flags & OSDISSTRM))
#define OSRTBUFSAVE(pctxt)
#define OSRTBUFRESTORE(pctxt)
#define rtxCtxtTestFlag(pctxt, mask)   ((pctxt->flags & mask) != 0)
 This macro tests if the given bit flag is set in the context.

Typedefs

typedef OSUINT32 OSRTFLAGS
typedef int(*) OSFreeCtxtAppInfoPtr (OSCTXT *pctxt)
typedef int(*) OSResetCtxtAppInfoPtr (OSCTXT *pctxt)

Functions

int rtxInitContext (OSCTXT *pctxt)
 This function initializes an OSCTXT block.
int rtxInitContextBuffer (OSCTXT *pctxt, OSOCTET *bufaddr, size_t bufsiz)
 This function assigns a message buffer to a context block.
int rtxCheckContext (OSCTXT *pctxt)
 This function verifies that the given context structure is initialized and ready for use.
void rtxFreeContext (OSCTXT *pctxt)
 This function frees all dynamic memory associated with a context.
void rtxCtxtSetFlag (OSCTXT *pctxt, OSUINT32 mask)
 This function is used to set a processing flag within the context structure.
void rtxCtxtClearFlag (OSCTXT *pctxt, OSUINT32 mask)
 This function is used to clear a processing flag within the context structure.

Detailed Description

Common run-time context definitions.

Definition in file rtxContext.h.