Changeset 81823 in vbox for trunk/include/iprt
- Timestamp:
- Nov 13, 2019 11:52:30 AM (5 years ago)
- File:
-
- 1 edited
-
trunk/include/iprt/req.h (modified) (20 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/iprt/req.h
r81822 r81823 75 75 typedef enum RTREQFLAGS 76 76 { 77 /** The request returns a iprtstatus code. */77 /** The request returns a IPRT status code. */ 78 78 RTREQFLAGS_IPRT_STATUS = 0, 79 79 /** The request is a void request and have no status code. */ … … 99 99 * Create a request packet queue 100 100 * 101 * @returns iprtstatus code.101 * @returns IPRT status code. 102 102 * @param phQueue Where to store the request queue handle. 103 103 */ … … 107 107 * Destroy a request packet queue 108 108 * 109 * @returns iprtstatus code.109 * @returns IPRT status code. 110 110 * @param hQueue The request queue. 111 111 */ … … 115 115 * Process one or more request packets 116 116 * 117 * @returns iprtstatus code. Any non-VINF_SUCCESS returns from request117 * @returns IPRT status code. Any non-VINF_SUCCESS returns from request 118 118 * processing is immediately propagated to the caller. 119 119 * @retval VERR_TIMEOUT if @a cMillies was reached without the packet being … … 171 171 * The returned request packet must be freed using RTReqRelease(). 172 172 * 173 * @returns iprtstatus code.173 * @returns IPRT status code. 174 174 * Will not return VERR_INTERRUPTED. 175 175 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed. … … 197 197 * The returned request packet must be freed using RTReqRelease(). 198 198 * 199 * @returns iprtstatus code.199 * @returns IPRT status code. 200 200 * Will not return VERR_INTERRUPTED. 201 201 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed. … … 225 225 * The returned request packet must be freed using RTReqRelease(). 226 226 * 227 * @returns iprtstatus code.227 * @returns IPRT status code. 228 228 * Will not return VERR_INTERRUPTED. 229 229 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed. … … 268 268 * union and queues the request. 269 269 * 270 * @returns iprtstatus code.270 * @returns IPRT status code. 271 271 * 272 272 * @param hQueue The request queue. … … 420 420 421 421 /** 422 * Read a statistics value from the request thread pool.422 * Reads a statistics value from the request thread pool. 423 423 * 424 424 * @returns The value, UINT64_MAX if an invalid parameter was given. … … 433 433 * This is mostly for internal use, please use the convenience methods. 434 434 * 435 * @returns iprtstatus code.435 * @returns IPRT status code. 436 436 * 437 437 * @param hPool The request thread pool handle. … … 442 442 443 443 /** 444 * Call a function on a worker thread.444 * Calls a function on a worker thread. 445 445 * 446 446 * @returns IPRT status code. … … 460 460 * that's larger than an uintptr_t is problematic. 461 461 */ 462 RTDECL(int) RTReqPoolCallEx( 463 464 465 /** 466 * Call a function on a worker thread.462 RTDECL(int) RTReqPoolCallEx(RTREQPOOL hPool, RTMSINTERVAL cMillies, PRTREQ *phReq, uint32_t fFlags, PFNRT pfnFunction, unsigned cArgs, ...); 463 464 465 /** 466 * Calls a function on a worker thread. 467 467 * 468 468 * @returns IPRT status code. … … 483 483 484 484 /** 485 * Call a function on a worker thread, wait for it to return.485 * Calls a function on a worker thread, wait for it to return. 486 486 * 487 487 * @returns IPRT status code returned by @a pfnFunction or request pool error. … … 498 498 499 499 /** 500 * Call a function on a worker thread, don't wait for it to return.500 * Calls a function on a worker thread, don't wait for it to return. 501 501 * 502 502 * @returns IPRT status code. … … 514 514 515 515 /** 516 * Call a void function on a worker thread.516 * Calls a void function on a worker thread. 517 517 * 518 518 * @returns IPRT status code. … … 543 543 544 544 /** 545 * Retains a reference to a request.545 * Retains a reference to a request. 546 546 * 547 547 * @returns The new reference count, UINT32_MAX on invalid handle (asserted). … … 561 561 562 562 /** 563 * Queue a request.564 * 565 * The quest must be allocated using RTReqQueueAlloc() or RTReqPoolAlloc() and563 * Queues a request. 564 * 565 * The request must be allocated using RTReqQueueAlloc() or RTReqPoolAlloc() and 566 566 * contain all the required data. 567 567 * … … 570 570 * use RT_INDEFINITE_WAIT. 571 571 * 572 * @returns iprtstatus code.572 * @returns IPRT status code. 573 573 * Will not return VERR_INTERRUPTED. 574 574 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed. … … 583 583 584 584 /** 585 * Wait for a request to be completed.586 * 587 * @returns iprtstatus code.585 * Waits for a request to be completed. 586 * 587 * @returns IPRT status code. 588 588 * Will not return VERR_INTERRUPTED. 589 589 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed. … … 596 596 597 597 /** 598 * Get the status of the request.599 * 600 * @returns Status code in the IPRT tradition.601 * 602 * @param pReq The request .598 * Gets the status of the request. 599 * 600 * @returns IPRT status code. 601 * 602 * @param pReq The request to get the status for. 603 603 */ 604 604 RTDECL(int) RTReqGetStatus(PRTREQ pReq);
Note:
See TracChangeset
for help on using the changeset viewer.
