CE Stub SPI
Detailed Description
Codec Engine System Programming Interface (SPI) for stub implementors.
Function Documentation
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. |
- See also:
- VISA_allocMsg()
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. |
- Return values:
-
| VISA_EOK | Success |
| VISA_ERUNTIME | General system error |
- See also:
- VISA_callAsync()
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. |
- Return values:
-
| VISA_EOK | Success |
| VISA_ERUNTIME | General system error |
- See also:
- VISA_wait()
-
VISA_call()
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()). |
- Return values:
-
| VISA_EOK | Success |
| VISA_ERUNTIME | General system error |
| VISA_ETIMEOUT | Operation timed out |
- See also:
- VISA_callAsync()
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. |
- 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.
- 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.
- See also:
- VISA_getContext()