Context Management Functions

Context initialization functions handle the allocation, initialization, and destruction of context variables (variables of type OSCTXT). More...

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	OSBufferIndex
	This structure can be used as an index into the buffer. 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	rtxCtxtPeekElemName(pctxt)
	This macro returns the last element name from the context stack.
#define	rtxByteAlign(pctxt)
	This macro will byte-align the context buffer.
#define	rtxCtxtSetProtocolVersion(pctxt, value) (pctxt)->version = value
	This macro sets the protocol version in the context.
Typedefs
typedef int(*	OSFreeCtxtAppInfoPtr )(struct OSCTXT *pctxt)
	OSRTFreeCtxtAppInfoPtr is a pointer to pctxt->pAppInfo free function, The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer to a structure and its first member should be a pointer to an appInfo free function.
typedef int(*	OSResetCtxtAppInfoPtr )(struct OSCTXT *pctxt)
	OSRTResetCtxtAppInfoPtr is a pointer to pctxt->pAppInfo reset function, The pctxt->pAppInfo (pXMLInfo and pASN1Info) should contain the pointer to a structure and its second member should be a pointer to appInfo reset function.
typedef void(*	OSFreeCtxtGlobalPtr )(struct OSCTXT *pctxt)
	OSRTFreeCtxtGlobalPtr is a pointer to a memory free function.
Functions
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	rtxInitContextUsingKey (OSCTXT pctxt, const OSOCTET key, OSSIZE keylen)
	This function initializes a context using a run-time key.
EXTERNRT int	rtxInitContextBuffer (OSCTXT pctxt, OSOCTET bufaddr, OSSIZE bufsiz)
	This function assigns a message buffer to a context block.
EXTERNRT int	rtxCtxtSetBufPtr (OSCTXT pctxt, OSOCTET bufaddr, OSSIZE bufsiz)
	This function is used to set the internal buffer pointer for in-memory encoding or decoding.
EXTERNRT OSSIZE	rtxCtxtGetBitOffset (OSCTXT *pctxt)
	This function returns the total bit offset to the current element in the context buffer.
EXTERNRT int	rtxCtxtSetBitOffset (OSCTXT *pctxt, OSSIZE offset)
	This function sets the bit offset in the context to the given value.
EXTERNRT OSSIZE	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	rtxCopyContext (OSCTXT pdest, OSCTXT psrc)
	This function creates a copy of a context structure.
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	rtxCtxtPushArrayElemName (OSCTXT pctxt, const OSUTF8CHAR elemName, OSSIZE idx)
	This function is used to push an array element name onto the context element name stack.
EXTERNRT int	rtxCtxtPushElemName (OSCTXT pctxt, const OSUTF8CHAR elemName)
	This function is used to push an element name onto the context element name stack.
EXTERNRT int	rtxCtxtPushTypeName (OSCTXT pctxt, const OSUTF8CHAR typeName)
	This function is used to push a type name onto the context element name stack.
EXTERNRT OSBOOL	rtxCtxtPopArrayElemName (OSCTXT *pctxt)
	This function pops the last element name from the context stack.
EXTERNRT const OSUTF8CHAR *	rtxCtxtPopElemName (OSCTXT *pctxt)
	This function pops the last element name from the context stack.
EXTERNRT const OSUTF8CHAR *	rtxCtxtPopTypeName (OSCTXT *pctxt)
	This function pops the type name from the context stack.
EXTERNRT OSBOOL	rtxCtxtContainerHasRemBits (OSCTXT *pctxt)
	Return true iff there are bits remaining to be decoded in the current length-constrained container, which is possibly the outer PDU.
EXTERNRT OSSIZE	rtxCtxtGetContainerRemBits (OSCTXT *pctxt)
	Return the number of bits remaining to be decoded in the current length-constrained container, which is possibly the outer PDU.
EXTERNRT int	rtxCtxtPushContainerBytes (OSCTXT *pctxt, OSSIZE bytes)
	Notify the runtime layer of the start of decoding of a length-constrained container of a given length.
EXTERNRT int	rtxCtxtPushContainerBits (OSCTXT *pctxt, OSSIZE bits)
	Notify the runtime layer of the start of decoding of a length-constrained container of a given length.
EXTERNRT void	rtxCtxtPopContainer (OSCTXT *pctxt)
	Notify the runtime layer of the end of decoding of a length-constrained container of the given length.
EXTERNRT void	rtxCtxtPopAllContainers (OSCTXT *pctxt)
	Pop all containers from the container stack.
EXTERNRT void	rtxMemHeapSetFlags (OSCTXT *pctxt, OSUINT32 flags)
	This function sets flags to a heap.
EXTERNRT void	rtxMemHeapClearFlags (OSCTXT *pctxt, OSUINT32 flags)
	This function clears memory heap flags.
EXTERNRT int	rtxMarkPos (OSCTXT pctxt, OSSIZE ppos)
	This function saves the current position in a message buffer or stream.
EXTERNRT int	rtxResetToPos (OSCTXT *pctxt, OSSIZE pos)
	This function resets a message buffer or stream back to the given position.

Detailed Description

Context initialization functions handle the allocation, initialization, and destruction of context variables (variables of type OSCTXT).

These variables hold all of the working data used during the process of encoding or decoding a message. The context provides thread safe operation by isolating what would otherwise be global variables within this structure. The context variable is passed from function to function as a message is encoded or decoded and maintains state information on the encoding or decoding process.

Define Documentation

#define rtxCtxtGetMsgLen ( pctxt ) (pctxt)->buffer.byteIndex

This macro returns the length of an encoded message.

It will only work for in-memory encoding, not for encode to stream.

Note that this macro will not work with ASN.1 BER in-memory encoding. In this case, the BER-specific version of the function must be used.

Parameters:

pctxt

Pointer to a context structure.

Definition at line 448 of file rtxContext.h.

#define rtxCtxtGetMsgPtr ( pctxt ) (pctxt)->buffer.data

This macro returns the start address of an encoded message.

If a static buffer was used, this is simply the start address of the buffer. If dynamic encoding was done, this will return the start address of the dynamic buffer allocated by the encoder.

Note that this macro will not work with ASN.1 BER in-memory encoding. In this case, the BER-specific version of the function must be used.

Parameters:

pctxt

Pointer to a context structure.

Definition at line 437 of file rtxContext.h.

#define rtxCtxtPeekElemName ( pctxt )

Value:

(((pctxt)->elemNameStack.count > 0) ? \
 (const OSUTF8CHAR*)(pctxt)->elemNameStack.tail->data : (const OSUTF8CHAR*)0)

This macro returns the last element name from the context stack.

Parameters:

pctxt

Pointer to a context structure.

Returns:: Element name from top of stack or NULL if stack is empty.

Definition at line 620 of file rtxContext.h.

#define rtxCtxtSetProtocolVersion	(	pctxt,
		value		)	(pctxt)->version = value

This macro sets the protocol version in the context.

This version number may be used in application code to do version specific operations. It is used in generated ASN.1 code with the extension addition version numbers to determine if an addition should be decoded.

For example, if this value is set to 8 and an extension addition group exists with version number 9 ([[ 9: ... ]]), its contents will not be decoded.

Parameters:

	pctxt	Pointer to a context structure.
	value	The version number value.

Definition at line 762 of file rtxContext.h.

#define rtxCtxtTestFlag	(	pctxt,
		mask		)	(((pctxt)->flags & mask) != 0)

This macro tests if the given bit flag is set in the context.

Parameters:

	pctxt	- A pointer to a context structure.
	mask	- Bit flag to be tested

Definition at line 533 of file rtxContext.h.

Typedef Documentation

typedef void(* OSFreeCtxtGlobalPtr)(struct OSCTXT *pctxt)

OSRTFreeCtxtGlobalPtr is a pointer to a memory free function.

This type describes the custom global memory free function generated by the compiler to free global nmemory. A pointer to a function of this type may be stored in the context gblFreeFunc field in order to free global data (pGlobalData) when rtxFreeContext is called.

Definition at line 165 of file rtxContext.h.

Function Documentation

EXTERNRT int rtxCheckContext ( OSCTXT * pctxt )

This function verifies that the given context structure is initialized and ready for use.

Parameters:

pctxt

Pointer to a context structure.

Returns:

Completion status of operation:

0 = success,
RTERR_NOTINIT status code if not initialized

EXTERNRT void rtxCopyContext	(	OSCTXT *	pdest,
		OSCTXT *	psrc
	)

This function creates a copy of a context structure.

The copy is a "shallow copy" (i.e. new copies of dynamic memory blocks held within the context are not made, only the pointers are transferred to the new context structure). This function is mainly for use from within compiler-generated code.

Parameters:

	pdest	- Context structure to which data is to be copied.
	psrc	- Context structure from which data is to be copied.

EXTERNRT void rtxCtxtClearFlag	(	OSCTXT *	pctxt,
		OSUINT32	mask
	)

This function is used to clear a processing flag within the context structure.

Parameters:

	pctxt	- A pointer to a context structure.
	mask	- Mask containing bit(s) to be cleared.

EXTERNRT OSBOOL rtxCtxtContainerHasRemBits ( OSCTXT * pctxt )

Return true iff there are bits remaining to be decoded in the current length-constrained container, which is possibly the outer PDU.

See also rtxCtxtPushContainer(Bits|Bytes)/rtxCtxtPopContainer

Parameters:

pctxt

Pointer to context structure.

EXTERNRT OSSIZE rtxCtxtGetBitOffset ( OSCTXT * pctxt )

This function returns the total bit offset to the current element in the context buffer.

Parameters:

pctxt

Pointer to a context structure.

Returns:: Bit offset.

EXTERNRT OSSIZE rtxCtxtGetContainerRemBits ( OSCTXT * pctxt )

Return the number of bits remaining to be decoded in the current length-constrained container, which is possibly the outer PDU.

See also rtxCtxtPushContainer(Bits|Bytes)/rtxCtxtPopContainer

Parameters:

pctxt

Pointer to context structure.

EXTERNRT OSSIZE rtxCtxtGetIOByteCount ( OSCTXT * pctxt )

This function returns the count of bytes either written to a stream or memory buffer.

Parameters:

pctxt

Pointer to a context structure.

Returns:: I/O byte count.

EXTERNRT void rtxCtxtPopAllContainers ( OSCTXT * pctxt )

Pop all containers from the container stack.

This is useful for clearing the stack when an error has occured. It is invoked automatically by rtxErrReset.

Parameters:

pctxt

Pointer to context structure.

EXTERNRT OSBOOL rtxCtxtPopArrayElemName ( OSCTXT * pctxt )

This function pops the last element name from the context stack.

This name is assumed to be an array element name pushed by the rtxCtxtPushArrayElemName function. The name is therefore dynamic and memory is freed for it using the rtxMemFreePtr function.

Parameters:

pctxt

Pointer to a context structure.

Returns:: True if name popped from stack or false if stack is empty.

EXTERNRT void rtxCtxtPopContainer ( OSCTXT * pctxt )

Notify the runtime layer of the end of decoding of a length-constrained container of the given length.

This method should be called when the final bit to be decoded has been decoded.

This pops an entry off of pctxt->containerEndIndex

Parameters:

pctxt

Pointer to context structure.

EXTERNRT const OSUTF8CHAR* rtxCtxtPopElemName ( OSCTXT * pctxt )

This function pops the last element name from the context stack.

Parameters:

pctxt

Pointer to a context structure.

Returns:: Element name popped from stack or NULL if stack is empty.

EXTERNRT const OSUTF8CHAR* rtxCtxtPopTypeName ( OSCTXT * pctxt )

This function pops the type name from the context stack.

The name is only popped if the item count is one.

Parameters:

pctxt

Pointer to a context structure.

Returns:: Type name popped from stack or NULL if stack count not equal to one.

EXTERNRT int rtxCtxtPushArrayElemName	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	elemName,
		OSSIZE	idx
	)

This function is used to push an array element name onto the context element name stack.

The name is formed by combining the given element name with the index to create a name of format name[index]. Dynamic memory is allocated for the resulting name using the rtxMemAlloc function.

Parameters:

	pctxt	Pointer to a context structure.
	elemName	Name of element to be pushed on stack.
	idx	Index or the array element.

Returns:

Completion status of operation:

0 = success,
RTERR_NOMEM if mem alloc for name fails.

EXTERNRT int rtxCtxtPushContainerBits	(	OSCTXT *	pctxt,
		OSSIZE	bits
	)

Notify the runtime layer of the start of decoding of a length-constrained container of a given length.

This method should be called when the next bit to be decoded is the first bit of the length-constrained content.

This pushes an entry onto pctxt->containerEndIndex.

Parameters:

	pctxt	Pointer to context structure.
	bits	Number of bits in the length-constrained container.

Returns:

Completion status of operation:

zero (0) = success,
negative return value is error.

EXTERNRT int rtxCtxtPushContainerBytes	(	OSCTXT *	pctxt,
		OSSIZE	bytes
	)

Notify the runtime layer of the start of decoding of a length-constrained container of a given length.

This method should be called when the next bit to be decoded is the first bit of the length-constrained content.

This pushes an entry onto pctxt->containerEndIndex.

Parameters:

	pctxt	Pointer to context structure.
	bytes	Number of bytes of the length-constrained container.

Returns:

Completion status of operation:

zero (0) = success,
negative return value is error.

EXTERNRT int rtxCtxtPushElemName	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	elemName
	)

This function is used to push an element name onto the context element name stack.

Parameters:

	pctxt	Pointer to a context structure.
	elemName	Name of element to be pushed on stack. Note that a copy of the name is not made, the pointer to the name that is passed is stored.

Returns:

Completion status of operation:

0 = success,
RTERR_NOMEM if mem alloc for name fails.

EXTERNRT int rtxCtxtPushTypeName	(	OSCTXT *	pctxt,
		const OSUTF8CHAR *	typeName
	)

This function is used to push a type name onto the context element name stack.

The name is only added for the top-level type. This is determined by testing to ensure that there are no existing names on the stack.

Parameters:

	pctxt	Pointer to a context structure.
	typeName	Name of type to be pushed on stack. Note that a copy of the name is not made, the pointer to the name that is passed is stored.

Returns:

Completion status of operation:

0 = success,
RTERR_NOMEM if mem alloc for name fails.

EXTERNRT int rtxCtxtSetBitOffset	(	OSCTXT *	pctxt,
		OSSIZE	offset
	)

This function sets the bit offset in the context to the given value.

Parameters:

	pctxt	Pointer to a context structure.
	offset	Bit offset.

Returns:

Completion status of operation:

0 = success,
Negative status code if error

EXTERNRT int rtxCtxtSetBufPtr	(	OSCTXT *	pctxt,
		OSOCTET *	bufaddr,
		OSSIZE	bufsiz
	)

This function is used to set the internal buffer pointer for in-memory encoding or decoding.

It must be called after the context variable is initialized before any other compiler generated or run-time library encode function.

Parameters:

	pctxt	Pointer to a context structure. This provides a storage area for the function to store all working variables that must be maintained between function calls.
	bufaddr	A pointer to a memory buffer to use to encode a message or that holds a message to be decoded. The buffer should be declared as an array of unsigned characters (OCTETs). This parameter can be set to NULL to specify dynamic encoding (i.e., the encode functions will dynamically allocate a buffer to hold the encoded message).
	bufsiz	The length of the memory buffer in bytes. Should be set to zero if NULL was specified for bufaddr (i.e. dynamic encoding was selected).

EXTERNRT void rtxCtxtSetFlag	(	OSCTXT *	pctxt,
		OSUINT32	mask
	)

This function is used to set a processing flag within the context structure.

Parameters:

	pctxt	- A pointer to a context structure.
	mask	- Mask containing bit(s) to be set.

EXTERNRT void rtxFreeContext ( OSCTXT * pctxt )

This function frees all dynamic memory associated with a context.

This includes all memory allocated using the rtxMem functions using the given context parameter.

Parameters:

pctxt

Pointer to a context structure.

EXTERNRT int rtxInitContext ( OSCTXT * pctxt )

This function initializes an OSCTXT block.

It sets all key working parameters to their correct initial state values. It is required that this function be invoked before using a context variable.

Parameters:

pctxt

Pointer to the context structure variable to be initialized.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

EXTERNRT int rtxInitContextBuffer	(	OSCTXT *	pctxt,
		OSOCTET *	bufaddr,
		OSSIZE	bufsiz
	)

This function assigns a message buffer to a context block.

The block should have been previously initialized by rtxInitContext.

Parameters:

	pctxt	The pointer to the context structure variable to be initialized.
	bufaddr	For encoding, the address of a memory buffer to receive the encoded message. If this address is NULL (0), encoding to a dynamic buffer will be done. For decoding, the address of a buffer that contains the message data to be decoded.
	bufsiz	The size of the memory buffer. For encoding, this argument may be set to zero to indicate a dynamic memory buffer should be used.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

EXTERNRT int rtxInitContextExt	(	OSCTXT *	pctxt,
		OSMallocFunc	malloc_func,
		OSReallocFunc	realloc_func,
		OSFreeFunc	free_func
	)

This function initializes an OSCTXT block.

It sets all key working parameters to their correct initial state values. It is required that this function be invoked before using a context variable.

Parameters:

	pctxt	Pointer to the context structure variable to be initialized.
	malloc_func	Pointer to the memory allocation function.
	realloc_func	Pointer to the memory reallocation function.
	free_func	Pointer to the memory deallocation function.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

EXTERNRT int rtxInitContextUsingKey	(	OSCTXT *	pctxt,
		const OSOCTET *	key,
		OSSIZE	keylen
	)

This function initializes a context using a run-time key.

This form is required for evaluation and limited distribution software. The compiler will generate a macro for rtXmlInitContext in the rtkey.h file that will invoke this function with the generated run-time key.

Parameters:

	pctxt	The pointer to the context structure variable to be initialized.
	key	Key data generated by ASN1C compiler.
	keylen	Key data field length.

Returns:

Completion status of operation:

0 (ASN_OK) = success,
negative return value is error.

EXTERNRT int rtxInitThreadContext	(	OSCTXT *	pctxt,
		const OSCTXT *	pSrcCtxt
	)

This function initializes a context for use in a thread.

It is the same as rtxInitContext except that it copies the pointer to constant data from the given source context into the newly initialized thread context. It is assumed that the source context has been initialized and the custom generated global initialization function has been called. The main purpose of this function is to prevent multiple copies of global static data from being created within different threads.

Parameters:

	pctxt	Pointer to the context structure variable to be initialized.
	pSrcCtxt	Pointer to source context which has been fully initialized including a pointer to global constant data initialized via a call to a generated 'Init_<project>_Global' function.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

EXTERNRT int rtxMarkPos	(	OSCTXT *	pctxt,
		OSSIZE *	ppos
	)

This function saves the current position in a message buffer or stream.

Parameters:

	pctxt	Pointer to a context block.
	ppos	Pointer to saved position.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

EXTERNRT void rtxMemHeapClearFlags	(	OSCTXT *	pctxt,
		OSUINT32	flags
	)

This function clears memory heap flags.

Parameters:

	pctxt	Pointer to a memory block structure that contains the list of dynamic memory block maintained by these functions.
	flags	The flags

EXTERNRT void rtxMemHeapSetFlags	(	OSCTXT *	pctxt,
		OSUINT32	flags
	)

This function sets flags to a heap.

May be used to control the heap's behavior.

Parameters:

	pctxt	Pointer to a memory block structure that contains the list of dynamic memory block maintained by these functions.
	flags	The flags.

EXTERNRT int rtxResetToPos	(	OSCTXT *	pctxt,
		OSSIZE	pos
	)

This function resets a message buffer or stream back to the given position.

Parameters:

	pctxt	Pointer to a context block.
	pos	Context position.

Returns:

Completion status of operation:

0 = success,
negative return value is error.

Context Management Functions

Classes

Defines

Typedefs

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation