Context

Internals of the Context module. More...

Collaboration diagram for Context:

Files
file	context.c
file	message_callback.c
file	message_callback_p.h
void	srpNewContext (SRPContext *pContext)
void	srpContextSetMessageCallback (SRPMessageCallbackType callback)
SRPMessageCallbackType	srpContextGetMessageCallback ()
void	srpContextSetP (SRPContextParameter contextParameter, void *data)
void	srpContextSetI (SRPContextParameter contextParameter, int data)
void	srpContextSetF (SRPContextParameter contextParameter, float data)
void *	srpContextGetP (SRPContextParameter contextParameter)
int	srpContextGetI (SRPContextParameter contextParameter)
float	srpContextGetF (SRPContextParameter contextParameter)
void	srpMessageCallbackHelper (SRPMessageType type, SRPMessageSeverity severity, const char *sourceFunction, const char *format,...)
#define	MAX_CHARS_IN_MESSAGE   1024

Detailed Description

Internals of the Context module.

See also

Context

Function Documentation

srpContextGetF()

float srpContextGetF

(

SRPContextParameter

contextParameter

)

Get a float parameter in the context

Parameters

[in]

contextParameter

The context parameter you want to get

Returns

Requested parameter or 0 on error

srpContextGetI()

int srpContextGetI

(

SRPContextParameter

contextParameter

)

Get an integer/enum parameter in the context

Parameters

[in]

contextParameter

The context parameter you want to get

Returns

Requested parameter or 0 on error

srpContextGetMessageCallback()

SRPMessageCallbackType srpContextGetMessageCallback

(

)

Get the current message callback function

Returns

The pointer to the current message callback function

srpContextGetP()

void * srpContextGetP

(

SRPContextParameter

contextParameter

)

Get a pointer parameter in the context

Parameters

[in]

contextParameter

The context parameter you want to get

Returns

Requested parameter or NULL on error

srpContextSetF()

void srpContextSetF	(	SRPContextParameter	contextParameter,
		float	data
	)

Set a float parameter in the context

Parameters

[in]	contextParameter	The context parameter you want to modify
[in]	data	The value you want to assign to specified context parameter

srpContextSetI()

void srpContextSetI	(	SRPContextParameter	contextParameter,
		int	data
	)

Set an integer/enum parameter in the context

Parameters

[in]	contextParameter	The context parameter you want to modify
[in]	data	The value you want to assign to specified context parameter

srpContextSetMessageCallback()

void srpContextSetMessageCallback

(

SRPMessageCallbackType

callback

)

Set message callback function

Parameters

[in]

callback

The pointer to the message callback function

srpContextSetP()

void srpContextSetP	(	SRPContextParameter	contextParameter,
		void *	data
	)

Set a pointer parameter in the context

Parameters

[in]	contextParameter	The context parameter you want to modify
[in]	data	The pointer you want to assign to specified context parameter

srpMessageCallbackHelper()

void srpMessageCallbackHelper	(	SRPMessageType	type,
		SRPMessageSeverity	severity,
		const char *	sourceFunction,
		const char *	format,
			...
	)

A helper function used by the library implementation to make callbacks easier

Parameters

[in]	type	Message type
[in]	severity	Message severity
[in]	sourceFunction	Function that is the source of this message
[in]	format	printf-like format string
[in]	...	Values passed to the format string

See also

SRPMessageCallbackType

srpNewContext()

void srpNewContext

(

SRPContext *

pContext

)

Initialize the context

Parameters

[in]

pContext

The pointer to context