diff options
author | William Joye <wjoye@cfa.harvard.edu> | 2017-10-26 16:45:12 (GMT) |
---|---|---|
committer | William Joye <wjoye@cfa.harvard.edu> | 2017-10-26 16:45:12 (GMT) |
commit | 6054f36bb658916bd231b9002efb94444e2871c8 (patch) | |
tree | a815500ec9bf0e100f4075a825213605c382def0 /doc/pod/xpapoll.pod | |
download | blt-6054f36bb658916bd231b9002efb94444e2871c8.zip blt-6054f36bb658916bd231b9002efb94444e2871c8.tar.gz blt-6054f36bb658916bd231b9002efb94444e2871c8.tar.bz2 |
Squashed 'xpa/' content from commit d6a54301
git-subtree-dir: xpa
git-subtree-split: d6a543018b46c5a6c47b5ff91e0e131549595ca6
Diffstat (limited to 'doc/pod/xpapoll.pod')
-rw-r--r-- | doc/pod/xpapoll.pod | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/pod/xpapoll.pod b/doc/pod/xpapoll.pod new file mode 100644 index 0000000..1f26ee1 --- /dev/null +++ b/doc/pod/xpapoll.pod @@ -0,0 +1,58 @@ +=pod + +=head1 NAME + + + +B<XPAPoll: execute existing XPA requests> + + + +=head1 SYNOPSIS + + + + + + #include <xpa.h> + + int XPAPoll(int msec, int maxreq); + + + + + +=head1 DESCRIPTION + + + + +It is sometimes desirable to implement a polling loop, i.e., where one +checks for and processes XPA requests without blocking. For this +situation, use the XPAPoll() routine: + + XPAPoll(int msec, int maxreq); + + +The XPAPoll() routine will perform XPAAddSelect() and select(), but with a +timeout specified in millisecs by the msec argument. If one or more +XPA requests are made before the timeout expires, the XPAProcessSelect() +routine is called to process those requests. The maxreq value determines +how many requests will be processed: if maxreq < 0, then no events are +processed, but instead, the return value indicates the number of events +that are pending. If maxreq == 0, then all currently pending requests +will be processed. Otherwise, up to maxreq requests will be processed. +(The most usual values for maxreq are 0 to process all requests and 1 +to process one request). + + + + +=head1 SEE ALSO + + + +See xpa(n) for a list of XPA help pages + + +=cut |