mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-11-03 09:01:52 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Improved comments for poll_descriptors

Browse source
This commit is contained in:
Jaroslav Kysela 2004-03-03 12:54:01 +00:00
parent 16a15f56c4
commit 0ecc03111d
1 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/pcm/pcm.c
View file

@ -1220,9 +1220,13 @@ int snd_pcm_poll_descriptors_count(snd_pcm_t *pcm)
* PCM handle. The poll desctiptor array should have the size returned by * PCM handle. The poll desctiptor array should have the size returned by
* \link ::snd_pcm_poll_descriptors_count() \endlink function. * \link ::snd_pcm_poll_descriptors_count() \endlink function.
* *
* The result is intended for direct use with the poll() syscall.
*
* For reading the returned events of poll descriptor after poll() system * For reading the returned events of poll descriptor after poll() system
* call, use \link ::snd_pcm_poll_descriptors_revents() \endlink function. * call, use \link ::snd_pcm_poll_descriptors_revents() \endlink function.
* The field values in pollfd structs may be bogus. * The field values in pollfd structs may be bogus regarding the stream
* direction from the application perspective (POLLIN might not imply read
* direction and POLLOUT might not imply write).
*/ */
int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space) int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int space)
{ {
@ -1243,6 +1247,9 @@ int snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int s
* \param nfds count of poll descriptors * \param nfds count of poll descriptors
* \param revents returned events * \param revents returned events
* \return zero if success, otherwise a negative error code * \return zero if success, otherwise a negative error code
*
* This function does "demangling" of the revents mask returned from
* the poll() syscall to correct semantics (POLLIN = read, POLLOUT = write).
*/ */
int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents) int snd_pcm_poll_descriptors_revents(snd_pcm_t *pcm, struct pollfd *pfds, unsigned int nfds, unsigned short *revents)
{ {