VLEVENTRECV(3dm)VLEVENTRECV(3dm)NAME
vlPathGetFD, vlEventRecv, vlEventToDMBuffer - event handling routines
SYNOPSIS
#include <dmedia/vl.h>
int vlPathGetFD(VLServer svr, VLPath path, int *ret_fd);
int vlEventRecv(VLServer svr, VLPath path, VLEvent *evp);
int vlEventToDMBuffer(VLEvent *evp, DMbuffer *dmbuffer);
DESCRIPTION
vlPathGetFD returns the file descriptor associated with the specified
path. This FD can be used in conjuction with a select(2) call for
notification that events are available for the path.
vlEventRecv returns the next event queued on the specified path. If no
event is available vlEventRecv returns -1 and sets vlErrno to VLAgain. If
the event is a VLTransferComplete event from a video source to a memory
drain, the event will have a DMBuffer associated with it. This buffer
must be obtained and released with calls to vlEventToDMBuffer and
dmBufferFree(3dm).
vlEventToDMBuffer converts a VLTransferComplete event into a DMBuffer.
The event must represent a transfer going from a video source to a memory
drain. An event can only be converted to a DMbuffer once. The DMbuffer is
released with a call to dmBufferFree(3dm).
DIAGNOSTICS
All routines return 0 if successful, otherwise -1 is returned and vlErrno
is set to indicate the error.
CAVEATS
These functions are obsolete. vlNextEvent or vlDMBufferGetValid should
be used instead.
SEE ALSOselect(2), dmBufferFree(3dm), vlintro(3dm)
Page 1