PIP_peek
Application Program Interface
2-281
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
framesize = PIP_peek(pipe, addr, rw);
Parameters
PIP_Handle pipe;
/* pipe object handle */
Ptr
*addr;
/* address of variable with frame address */
Uns
rw;
/* flag to indicate the reader or writer side */
Return Value
Int
framesize;/* the frame size */
Description
PIP_peek can be used before calling PIP_alloc or PIP_get to get the pipe
frame size and address without actually claiming the pipe frame.
The pipe parameter is the pipe object handle, the addr parameter is the
address of the variable that keeps the retrieved frame address, and the
rw parameter is the flag that indicates what side of the pipe PIP_peek is
to operate on. If rw is PIP_READER, then PIP_peek operates on the
reader side of the pipe. If rw is PIP_WRITER, then PIP_peek operates on
the writer side of the pipe.
PIP_getReaderNumFrames or PIP_getWriterNumFrames can be called
to ensure that a frame exists before calling PIP_peek, although PIP_peek
returns –1 if no pipe frame exists.
PIP_peek returns the frame size, or –1 if no pipe frames are available. If
the return value of PIP_peek in frame size is not –1, then *addr is the
location of the frame address.
See Also
PIP_alloc
PIP_free
PIP_get
PIP_put
PIP_reset
PIP_peek
Get pipe frame size and address without actually claiming pipe frame