| … | |
… | |
| 153 | |
153 | |
| 154 | You submit a request by calling the relevant C<eio_TYPE> function with the |
154 | You submit a request by calling the relevant C<eio_TYPE> function with the |
| 155 | required parameters, a callback of type C<int (*eio_cb)(eio_req *req)> |
155 | required parameters, a callback of type C<int (*eio_cb)(eio_req *req)> |
| 156 | (called C<eio_cb> below) and a freely usable C<void *data> argument. |
156 | (called C<eio_cb> below) and a freely usable C<void *data> argument. |
| 157 | |
157 | |
| 158 | The return value will either be 0 |
158 | The return value will either be 0, in case something went really wrong |
|
|
159 | (which can basically only happen on very fatal errors, such as C<malloc> |
|
|
160 | returning 0, which is rather unlikely), or a pointer to the newly-created |
|
|
161 | and submitted C<eio_req *>. |
| 159 | |
162 | |
| 160 | The callback will be called with an C<eio_req *> which contains the |
163 | The callback will be called with an C<eio_req *> which contains the |
| 161 | results of the request. The members you can access inside that structure |
164 | results of the request. The members you can access inside that structure |
| 162 | vary from request to request, except for: |
165 | vary from request to request, except for: |
| 163 | |
166 | |
| … | |
… | |
| 568 | |
571 | |
| 569 | =back |
572 | =back |
| 570 | |
573 | |
| 571 | =head3 GROUPING AND LIMITING REQUESTS |
574 | =head3 GROUPING AND LIMITING REQUESTS |
| 572 | |
575 | |
|
|
576 | There is one more rather special request, C<eio_grp>. It is a very special |
|
|
577 | aio request: Instead of doing something, it is a container for other eio |
|
|
578 | requests. |
|
|
579 | |
|
|
580 | There are two primary use cases for this: a) bundle many requests into a |
|
|
581 | single, composite, request with a definite callback and the ability to |
|
|
582 | cancel the whole request with its subrequests and b) limiting the number |
|
|
583 | of "active" requests. |
|
|
584 | |
|
|
585 | Further below you will find more dicussion of these topics - first follows |
|
|
586 | the reference section detailing the request generator and other methods. |
|
|
587 | |
|
|
588 | =over 4 |
|
|
589 | |
|
|
590 | =item eio_grp (eio_cb cb, void *data) |
|
|
591 | |
|
|
592 | Creates and submits a group request. |
|
|
593 | |
|
|
594 | =back |
|
|
595 | |
|
|
596 | |
|
|
597 | |
| 573 | #TODO |
598 | #TODO |
| 574 | |
599 | |
| 575 | /*****************************************************************************/ |
600 | /*****************************************************************************/ |
| 576 | /* groups */ |
601 | /* groups */ |
| 577 | |
602 | |
