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 | OSRTBuffer |
| Run-time message buffer structure. More... | |
| struct | OSRTBufSave |
| Structure to save the current message buffer state. More... | |
| struct | OSCTXT |
| Run-time context structure. More... | |
Defines | |
| #define | rtxCtxtGetMsgPtr(pctxt) (pctxt)->buffer.data |
| This macro returns the start address of an encoded message. | |
| #define | rtxCtxtGetMsgLen(pctxt) (pctxt)->buffer.byteIndex |
| This macro returns the length of an encoded message. | |
| #define | rtxCtxtTestFlag(pctxt, mask) ((pctxt->flags & mask) != 0) |
| This macro tests if the given bit flag is set in the context. | |
| #define | rtxByteAlign(pctxt) |
| This macro will byte-align the context buffer. | |
Functions | |
| EXTERNRT int | rtxInitContextUsingKey (OSCTXT *pctxt, const OSOCTET *key, size_t keylen) |
| This function initializes a context using a run-time key. | |
| EXTERNRT int | rtxInitContext (OSCTXT *pctxt) |
| This function initializes an OSCTXT block. | |
| EXTERNRT int | rtxInitContextExt (OSCTXT *pctxt, OSMallocFunc malloc_func, OSReallocFunc realloc_func, OSFreeFunc free_func) |
| This function initializes an OSCTXT block. | |
| EXTERNRT int | rtxInitThreadContext (OSCTXT *pctxt, const OSCTXT *pSrcCtxt) |
| This function initializes a context for use in a thread. | |
| EXTERNRT int | rtxInitContextBuffer (OSCTXT *pctxt, OSOCTET *bufaddr, size_t bufsiz) |
| This function assigns a message buffer to a context block. | |
| EXTERNRT int | rtxCtxtSetBufPtr (OSCTXT *pctxt, OSOCTET *bufaddr, size_t bufsiz) |
| This function is used to set the internal buffer pointer for in-memory encoding or decoding. | |
| EXTERNRT size_t | rtxCtxtGetIOByteCount (OSCTXT *pctxt) |
| This function returns the count of bytes either written to a stream or memory buffer. | |
| EXTERNRT int | rtxCheckContext (OSCTXT *pctxt) |
| This function verifies that the given context structure is initialized and ready for use. | |
| EXTERNRT void | rtxFreeContext (OSCTXT *pctxt) |
| This function frees all dynamic memory associated with a context. | |
| EXTERNRT void | rtxCtxtSetFlag (OSCTXT *pctxt, OSUINT32 mask) |
| This function is used to set a processing flag within the context structure. | |
| EXTERNRT void | rtxCtxtClearFlag (OSCTXT *pctxt, OSUINT32 mask) |
| This function is used to clear a processing flag within the context structure. | |
| EXTERNRT int | rtxCtxtPushElemName (OSCTXT *pctxt, const OSUTF8CHAR *elemName) |
| This function is used to push an element name onto the context element name stack. | |
| EXTERNRT const OSUTF8CHAR * | rtxCtxtPopElemName (OSCTXT *pctxt) |
| This function pops the last element name from the context stack. | |
Detailed Description
Common run-time context definitions.
Definition in file rtxContext.h.