VISA - CE Stub SPIs

Data Structures
struct	VISA_MsgHeader
	VISA message header. More...
Typedefs
typedef struct VISA_MsgHeader	VISA_MsgHeader
	VISA message header.
Functions
VISA_Msg	VISA_allocMsg (VISA_Handle visa)
	Obtain an algorithm instance's message.
VISA_Status	VISA_call (VISA_Handle visa, VISA_Msg *msg)
	Invoke the operation specified in the message and wait for it to complete.
VISA_Status	VISA_callAsync (VISA_Handle visa, VISA_Msg *msg)
	Invoke the operation specified in the message and return without waiting for it to complete.
VISA_Status	VISA_wait (VISA_Handle visa, VISA_Msg *msg, UInt timeout)
	Wait for the oldest operation from a command specified with VISA_callAsync() to complete.
Void	VISA_freeMsg (VISA_Handle visa, VISA_Msg msg)
	Release an algorithm instance's message.
Void	VISA_getContext (VISA_Handle visa, UInt32 *pContext)
	Get optional context parameter.
Void	VISA_setContext (VISA_Handle visa, UInt32 context)
	Set optional context parameter.

---

Detailed Description

Codec Engine System Programming Interface (SPI) for stub implementors.

---

Typedef Documentation

typedef struct VISA_MsgHeader VISA_MsgHeader

VISA message header.

Remarks:

This must be the first field in a message

---

Function Documentation

VISA_Msg VISA_allocMsg

(

VISA_Handle

visa )

Obtain an algorithm instance's message.

Parameters:

[in]

visa

Handle to an algorithm instance.

Return values:

NULL	General system error
non-NULL	The remote algorithm's message.

Remarks:

This is typically called by an algorithm class' stub.

See also:

VISA_allocMsg()

VISA_Status VISA_call	(	VISA_Handle	visa,
		VISA_Msg *	msg
	)

Invoke the operation specified in the message and wait for it to complete.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	msg	The remote algorithm's message, to be sent to the skeleton.

Remarks:

This is typically called by an algorithm class' stub.

Return values:

VISA_EOK	Success
VISA_ERUNTIME	General system error

See also:

VISA_callAsync()

VISA_Status VISA_callAsync	(	VISA_Handle	visa,
		VISA_Msg *	msg
	)

Invoke the operation specified in the message and return without waiting for it to complete.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	msg	The remote algorithm's message, to be sent to the skeleton.

Remarks:

This is typically called by an algorithm class' stub.

Return values:

VISA_EOK	Success
VISA_ERUNTIME	General system error

See also:

VISA_wait()

VISA_call()

VISA_Status VISA_wait	(	VISA_Handle	visa,
		VISA_Msg *	msg,
		UInt	timeout
	)

Wait for the oldest operation from a command specified with VISA_callAsync() to complete.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	msg	Placeholder for the remote algorithm's return message, retrieved from the skeleton.
[in]	timeout	Amount of "time" to wait ("time" depends on underlying mechanism, such as that used with MSGQ_Get()).

Remarks:

This is typically called by an algorithm class' stub.

Return values:

VISA_EOK	Success
VISA_ERUNTIME	General system error
VISA_ETIMEOUT	Operation timed out

See also:

VISA_callAsync()

Void VISA_freeMsg	(	VISA_Handle	visa,
		VISA_Msg	msg
	)

Release an algorithm instance's message.

Parameters:

[in]	visa	Handle to an algorithm instance.
[in]	msg	Message to free, obtained through a call to VISA_allocMsg().

Return values:

NULL	General system error
non-NULL	The remote algorithm's message.

Remarks:

This is typically called by an algorithm class' stub.

See also:

VISA_allocMsg()

Void VISA_getContext	(	VISA_Handle	visa,
		UInt32 *	pContext
	)

Get optional context parameter.

Parameters:

[in]	visa	Handle to an algorithm instance.
[out]	pContext	Location to store context.

Precondition:

visa must be a valid algorithm instance handle.

pContext must be a valid pointer.

Remarks:

The VISA_setContext() / VISA_getContext() pair does not work across processors. That is, the context can only be stored and retrieved on the local processor.

See also:

VISA_setContext()

Void VISA_setContext	(	VISA_Handle	visa,
		UInt32	context
	)

Set optional context parameter.

Parameters:

[in]	visa	Handle to an algorithm instance.
[in]	context	Context.

Precondition:

visa must be a valid algorithm instance handle.

Remarks:

The VISA_setContext() / VISA_getContext() pair does not work across processors. That is, the context can only be stored and retrieved on the local processor.

See also:

VISA_getContext()