VirtualBox

Changeset 57926 in vbox for trunk/include/iprt/condvar.h


Ignore:
Timestamp:
Sep 28, 2015 2:05:58 PM (9 years ago)
Author:
vboxsync
Message:

IPRT: Doxygen clenaups (mostly).

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/condvar.h

    r57004 r57926  
    5454 *                              condition variable.
    5555 */
    56 RTDECL(int)  RTConvVarCreate(PRTCONDVAR phCondVar);
     56RTDECL(int)  RTCondVarCreate(PRTCONDVAR phCondVar);
    5757
    5858/**
    … …  
    7272 * @param   ...                 Format string arguments.
    7373 */
    74 RTDECL(int)  RTConvVarCreateEx(PRTCONDVAR phCondVar, uint32_t fFlags, RTLOCKVALCLASS hClass,
     74RTDECL(int)  RTCondVarCreateEx(PRTCONDVAR phCondVar, uint32_t fFlags, RTLOCKVALCLASS hClass,
    7575                               const char *pszNameFmt, ...) RT_IPRT_FORMAT_ATTR(4, 5);
    7676
    77 /** @name RTConvVarCreateEx flags
     77/** @name RTCondVarCreateEx flags
    7878 * @{ */
    7979/** Disables lock validation. */
    … …  
    8888 *                              is quietly ignored (VINF_SUCCESS).
    8989 */
    90 RTDECL(int)  RTConvVarDestroy(RTCONDVAR hCondVar);
     90RTDECL(int)  RTCondVarDestroy(RTCONDVAR hCondVar);
    9191
    9292/**
    … …  
    100100 *
    101101 * @returns iprt status code.
    102  * @param   hConvVar            The condition variable to signal.
    103  */
    104 RTDECL(int)  RTConvVarSignal(RTCONDVAR hCondVar);
     102 * @param   hCondVar            The condition variable to signal.
     103 */
     104RTDECL(int)  RTCondVarSignal(RTCONDVAR hCondVar);
    105105
    106106/**
    … …  
    114114 *
    115115 * @returns iprt status code.
    116  * @param   hConvVar            The condition variable to broadcast.
    117  */
    118 RTDECL(int)  RTConvVarBroadcast(RTCONDVAR hCondVar);
    119 
    120 /**
    121  * Wait for the condition variable to be signaled, resume on interruption.
    122  *
    123  * This function will resume if the wait is interrupted by an async system event
    124  * (like a unix signal) or similar.
    125  *
    126  * @returns iprt status code.
    127  *          Will not return VERR_INTERRUPTED.
    128  * @param   hConvVar            The condition variable to wait on.
     116 * @param   hCondVar            The condition variable to broadcast.
     117 */
     118RTDECL(int)  RTCondVarBroadcast(RTCONDVAR hCondVar);
     119
     120/**
     121 * Wait for the condition variable to be signaled, resume on interruption.
     122 *
     123 * This function will resume if the wait is interrupted by an async system event
     124 * (like a unix signal) or similar.
     125 *
     126 * @returns iprt status code.
     127 *          Will not return VERR_INTERRUPTED.
     128 * @param   hCondVar            The condition variable to wait on.
    129129 * @param   hMtx                The mutex to leave during the wait and which
    130130 *                              will be re-enter before returning.
    … …  
    132132 *                              RT_INDEFINITE_WAIT to wait forever.
    133133 */
    134 RTDECL(int)  RTConvVarMutexWait(RTCONDVAR hCondVar, RTSEMMUTEX hMtx, RTMSINTERVAL cMillies);
    135 
    136 /**
    137  * Wait for the condition variable to be signaled, return on interruption.
    138  *
    139  * This function will not resume the wait if interrupted.
    140  *
    141  * @returns iprt status code.
    142  * @param   hConvVar            The condition variable to wait on.
     134RTDECL(int)  RTCondVarMutexWait(RTCONDVAR hCondVar, RTSEMMUTEX hMtx, RTMSINTERVAL cMillies);
     135
     136/**
     137 * Wait for the condition variable to be signaled, return on interruption.
     138 *
     139 * This function will not resume the wait if interrupted.
     140 *
     141 * @returns iprt status code.
     142 * @param   hCondVar            The condition variable to wait on.
    143143 * @param   hMtx                The mutex to leave during the wait and which
    144144 *                              will be re-enter before returning.
    … …  
    146146 *                              RT_INDEFINITE_WAIT to wait forever.
    147147 */
    148 RTDECL(int)  RTConvVarMutexWaitNoResume(RTCONDVAR hCondVar, RTSEMMUTEX hMtx, RTMSINTERVAL cMillies);
    149 
    150 /**
    151  * Wait for the condition variable to be signaled, resume on interruption.
    152  *
    153  * This function will resume if the wait is interrupted by an async system event
    154  * (like a unix signal) or similar.
    155  *
    156  * @returns iprt status code.
    157  *          Will not return VERR_INTERRUPTED.
    158  * @param   hConvVar            The condition variable to wait on.
     148RTDECL(int)  RTCondVarMutexWaitNoResume(RTCONDVAR hCondVar, RTSEMMUTEX hMtx, RTMSINTERVAL cMillies);
     149
     150/**
     151 * Wait for the condition variable to be signaled, resume on interruption.
     152 *
     153 * This function will resume if the wait is interrupted by an async system event
     154 * (like a unix signal) or similar.
     155 *
     156 * @returns iprt status code.
     157 *          Will not return VERR_INTERRUPTED.
     158 * @param   hCondVar            The condition variable to wait on.
    159159 * @param   hRWSem              The read/write semaphore to write-leave during
    160160 *                              the wait and which will be re-enter in write
    … …  
    163163 *                              RT_INDEFINITE_WAIT to wait forever.
    164164 */
    165 RTDECL(int)  RTConvVarRWWriteWait(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
    166 
    167 /**
    168  * Wait for the condition variable to be signaled, return on interruption.
    169  *
    170  * This function will not resume the wait if interrupted.
    171  *
    172  * @returns iprt status code.
    173  * @param   hConvVar            The condition variable to wait on.
     165RTDECL(int)  RTCondVarRWWriteWait(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
     166
     167/**
     168 * Wait for the condition variable to be signaled, return on interruption.
     169 *
     170 * This function will not resume the wait if interrupted.
     171 *
     172 * @returns iprt status code.
     173 * @param   hCondVar            The condition variable to wait on.
    174174 * @param   hRWSem              The read/write semaphore to write-leave during
    175175 *                              the wait and which will be re-enter in write
    … …  
    178178 *                              RT_INDEFINITE_WAIT to wait forever.
    179179 */
    180 RTDECL(int)  RTConvVarRWWriteWaitNoResume(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
    181 
    182 /**
    183  * Wait for the condition variable to be signaled, resume on interruption.
    184  *
    185  * This function will resume if the wait is interrupted by an async system event
    186  * (like a unix signal) or similar.
    187  *
    188  * @returns iprt status code.
    189  *          Will not return VERR_INTERRUPTED.
    190  * @param   hConvVar            The condition variable to wait on.
     180RTDECL(int)  RTCondVarRWWriteWaitNoResume(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
     181
     182/**
     183 * Wait for the condition variable to be signaled, resume on interruption.
     184 *
     185 * This function will resume if the wait is interrupted by an async system event
     186 * (like a unix signal) or similar.
     187 *
     188 * @returns iprt status code.
     189 *          Will not return VERR_INTERRUPTED.
     190 * @param   hCondVar            The condition variable to wait on.
    191191 * @param   hRWSem              The read/write semaphore to read-leave during
    192192 *                              the wait and which will be re-enter in read mode
    … …  
    195195 *                              RT_INDEFINITE_WAIT to wait forever.
    196196 */
    197 RTDECL(int)  RTConvVarRWReadWait(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
    198 
    199 /**
    200  * Wait for the condition variable to be signaled, return on interruption.
    201  *
    202  * This function will not resume the wait if interrupted.
    203  *
    204  * @returns iprt status code.
    205  * @param   hConvVar            The condition variable to wait on.
     197RTDECL(int)  RTCondVarRWReadWait(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
     198
     199/**
     200 * Wait for the condition variable to be signaled, return on interruption.
     201 *
     202 * This function will not resume the wait if interrupted.
     203 *
     204 * @returns iprt status code.
     205 * @param   hCondVar            The condition variable to wait on.
    206206 * @param   hRWSem              The read/write semaphore to read-leave during
    207207 *                              the wait and which will be re-enter in read mode
    … …  
    210210 *                              RT_INDEFINITE_WAIT to wait forever.
    211211 */
    212 RTDECL(int)  RTConvVarRWReadWaitNoResume(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
    213 
    214 /**
    215  * Wait for the condition variable to be signaled, resume on interruption.
    216  *
    217  * This function will resume if the wait is interrupted by an async system event
    218  * (like a unix signal) or similar.
    219  *
    220  * @returns iprt status code.
    221  *          Will not return VERR_INTERRUPTED.
    222  * @param   hConvVar            The condition variable to wait on.
     212RTDECL(int)  RTCondVarRWReadWaitNoResume(RTCONDVAR hCondVar, RTSEMRW hRWSem, RTMSINTERVAL cMillies);
     213
     214/**
     215 * Wait for the condition variable to be signaled, resume on interruption.
     216 *
     217 * This function will resume if the wait is interrupted by an async system event
     218 * (like a unix signal) or similar.
     219 *
     220 * @returns iprt status code.
     221 *          Will not return VERR_INTERRUPTED.
     222 * @param   hCondVar            The condition variable to wait on.
    223223 * @param   pCritSect           The critical section to leave during the wait
    224224 *                              and which will be re-enter before returning.
    … …  
    226226 *                              RT_INDEFINITE_WAIT to wait forever.
    227227 */
    228 RTDECL(int)  RTConvVarCritSectWait(RTCONDVAR hCondVar, PRTCRITSECT pCritSect, RTMSINTERVAL cMillies);
    229 
    230 /**
    231  * Wait for the condition variable to be signaled, return on interruption.
    232  *
    233  * This function will not resume the wait if interrupted.
    234  *
    235  * @returns iprt status code.
    236  * @param   hConvVar            The condition variable to wait on.
     228RTDECL(int)  RTCondVarCritSectWait(RTCONDVAR hCondVar, PRTCRITSECT pCritSect, RTMSINTERVAL cMillies);
     229
     230/**
     231 * Wait for the condition variable to be signaled, return on interruption.
     232 *
     233 * This function will not resume the wait if interrupted.
     234 *
     235 * @returns iprt status code.
     236 * @param   hCondVar            The condition variable to wait on.
    237237 * @param   pCritSect           The critical section to leave during the wait
    238238 *                              and which will be re-enter before returning.
    … …  
    240240 *                              RT_INDEFINITE_WAIT to wait forever.
    241241 */
    242 RTDECL(int)  RTConvVarCritSectWaitNoResume(RTCONDVAR hCondVar, PRTCRITSECT pCritSect, RTMSINTERVAL cMillies);
     242RTDECL(int)  RTCondVarCritSectWaitNoResume(RTCONDVAR hCondVar, PRTCRITSECT pCritSect, RTMSINTERVAL cMillies);
    243243
    244244/**
    … …  
    246246 *
    247247 * This is only used for validating usage and deadlock detection.  When used
    248  * after calls to RTConvVarAddSignaller, the specified thread will be the only
     248 * after calls to RTCondVarAddSignaller, the specified thread will be the only
    249249 * signalling thread.
    250250 *
    251  * @param   hConvVar            The condition variable.
     251 * @param   hCondVar            The condition variable.
    252252 * @param   hThread             The thread that will signal it.  Pass
    253253 *                              NIL_RTTHREAD to indicate that there is no
    254254 *                              special signalling thread.
    255255 */
    256 RTDECL(void) RTConvVarSetSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
     256RTDECL(void) RTCondVarSetSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
    257257
    258258/**
    … …  
    261261 * First call RTCondVarSetSignaller then add further threads with this.
    262262 *
    263  * @param   hConvVar            The condition variable.
     263 * @param   hCondVar            The condition variable.
    264264 * @param   hThread             The thread that will signal it. NIL_RTTHREAD is
    265265 *                              not accepted.
    266266 */
    267 RTDECL(void) RTConvVarAddSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
     267RTDECL(void) RTCondVarAddSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
    268268
    269269/**
    … …  
    272272 * Reverts work done by RTCondVarAddSignaller and RTCondVarSetSignaller.
    273273 *
    274  * @param   hConvVar            The condition variable.
     274 * @param   hCondVar            The condition variable.
    275275 * @param   hThread             A previously added thread.
    276276 */
    277 RTDECL(void) RTConvVarRemoveSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
     277RTDECL(void) RTCondVarRemoveSignaller(RTCONDVAR hCondVar, RTTHREAD hThread);
    278278
    279279/** @} */
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette