PIP_get
2-274
Important Note:
This API is being deprecated and will no longer be
supported in the next major release of DSP/BIOS. We recommend that
you use the SIO module instead. The PIP module is still supported in
DSP/BIOS 5.32 and will be supported in any patch releases or minor
enhancements to DSP/BIOS 5.32.
C Interface
Syntax
PIP_get(pipe);
Parameters
PIP_Handle pipe;
/* pipe object handle */
Return Value
Void
Reentrant
no
Description
PIP_get gets a frame from the pipe after some other function puts the
frame into the pipe with PIP_put.
If full frames are available after PIP_get gets a frame, PIP_get runs the
function specified by the notifyReader property of the PIP object. This
function should notify (for example, by calling SWI_andnHook) the object
that reads from this pipe that a full frame is available. The notifyReader
function is performed as part of the thread that calls PIP_get or PIP_put.
To avoid problems with recursion, the notifyReader function should not
directly call any PIP module functions for the same pipe.
Constraints and
Calling Context
❏
Before calling PIP_get, a function should check the
readerNumFrames member of the PIP_Obj structure by calling
PIP_getReaderNumFrames to make sure it is greater than 0 (that is,
at least one full frame is available).
❏
PIP_get can only be called one time before calling PIP_free. You
cannot operate on two frames from the same pipe simultaneously.
Example
See the example for PIP_alloc, page 2–271. The example for
HST_getpipe, page 2–147, also uses a pipe with host channel objects.
See Also
PIP_alloc
PIP_free
PIP_put
HST_getpipe
PIP_get
Get a full frame from the pipe