<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Apache Portable Runtime: Atomic Operations</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.4.7 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul></div> <h1>Atomic Operations<br> <small> [<a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a>]</small> </h1><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#gbe2b498dae686f68a67f676130b9aa23">apr_atomic_init</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g617533320c72e324765b1a114e6f88ba">apr_atomic_read32</a> (volatile apr_uint32_t *mem)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g406ecb97d6beb6d8c5574e3a75900efe">apr_atomic_set32</a> (volatile apr_uint32_t *mem, apr_uint32_t val)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g86030e8f8f7915f74b0f172e91f1994d">apr_atomic_add32</a> (volatile apr_uint32_t *mem, apr_uint32_t val)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g2504e42aaef47c770f9a7d2bfbf9122b">apr_atomic_sub32</a> (volatile apr_uint32_t *mem, apr_uint32_t val)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g8689c6c810716f9947edc16847ba6461">apr_atomic_inc32</a> (volatile apr_uint32_t *mem)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g9f9b830560833ab0e7b48144b5902981">apr_atomic_dec32</a> (volatile apr_uint32_t *mem)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g2b965b3bce1b8ba0e0cbe323a877639a">apr_atomic_cas32</a> (volatile apr_uint32_t *mem, apr_uint32_t with, apr_uint32_t cmp)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g8e0f6b1ed6b8fa8a091affe81c33a386">apr_atomic_xchg32</a> (volatile apr_uint32_t *mem, apr_uint32_t val)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__atomic.html#g2847b3d12299c2ca5f055ffdc6ec3031">apr_atomic_casptr</a> (volatile void **mem, void *with, const void *cmp)</td></tr> </table> <hr><h2>Function Documentation</h2> <a class="anchor" name="g86030e8f8f7915f74b0f172e91f1994d"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_add32" ref="g86030e8f8f7915f74b0f172e91f1994d" args="(volatile apr_uint32_t *mem, apr_uint32_t val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_uint32_t apr_atomic_add32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>val</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically add 'val' to an apr_uint32_t <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>amount to add </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>old value pointed to by mem </dd></dl> </div> </div><p> <a class="anchor" name="g2b965b3bce1b8ba0e0cbe323a877639a"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_cas32" ref="g2b965b3bce1b8ba0e0cbe323a877639a" args="(volatile apr_uint32_t *mem, apr_uint32_t with, apr_uint32_t cmp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_uint32_t apr_atomic_cas32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>with</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>cmp</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> compare an apr_uint32_t's value with 'cmp'. If they are the same swap the value with 'with' <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the value </td></tr> <tr><td valign="top"></td><td valign="top"><em>with</em> </td><td>what to swap it with </td></tr> <tr><td valign="top"></td><td valign="top"><em>cmp</em> </td><td>the value to compare it to </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>the old value of *mem </dd></dl> </div> </div><p> <a class="anchor" name="g2847b3d12299c2ca5f055ffdc6ec3031"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_casptr" ref="g2847b3d12299c2ca5f055ffdc6ec3031" args="(volatile void **mem, void *with, const void *cmp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* apr_atomic_casptr </td> <td>(</td> <td class="paramtype">volatile void ** </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"> <em>with</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const void * </td> <td class="paramname"> <em>cmp</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> compare the pointer's value with cmp. If they are the same swap the value with 'with' <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the pointer </td></tr> <tr><td valign="top"></td><td valign="top"><em>with</em> </td><td>what to swap it with </td></tr> <tr><td valign="top"></td><td valign="top"><em>cmp</em> </td><td>the value to compare it to </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>the old value of the pointer </dd></dl> </div> </div><p> <a class="anchor" name="g9f9b830560833ab0e7b48144b5902981"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_dec32" ref="g9f9b830560833ab0e7b48144b5902981" args="(volatile apr_uint32_t *mem)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_atomic_dec32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically decrement an apr_uint32_t by 1 <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the atomic value </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>zero if the value becomes zero on decrement, otherwise non-zero </dd></dl> </div> </div><p> <a class="anchor" name="g8689c6c810716f9947edc16847ba6461"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_inc32" ref="g8689c6c810716f9947edc16847ba6461" args="(volatile apr_uint32_t *mem)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_uint32_t apr_atomic_inc32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically increment an apr_uint32_t by 1 <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the object </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>old value pointed to by mem </dd></dl> </div> </div><p> <a class="anchor" name="gbe2b498dae686f68a67f676130b9aa23"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_init" ref="gbe2b498dae686f68a67f676130b9aa23" args="(apr_pool_t *p)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_atomic_init </td> <td>(</td> <td class="paramtype"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td> <td class="paramname"> <em>p</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> this function is required on some platforms to initialize the atomic operation's internal structures <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>pool </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS on successful completion </dd></dl> </div> </div><p> <a class="anchor" name="g617533320c72e324765b1a114e6f88ba"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_read32" ref="g617533320c72e324765b1a114e6f88ba" args="(volatile apr_uint32_t *mem)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_uint32_t apr_atomic_read32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically read an apr_uint32_t from memory <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>the pointer </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="g406ecb97d6beb6d8c5574e3a75900efe"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_set32" ref="g406ecb97d6beb6d8c5574e3a75900efe" args="(volatile apr_uint32_t *mem, apr_uint32_t val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void apr_atomic_set32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>val</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically set an apr_uint32_t in memory <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value that the object will assume </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="g2504e42aaef47c770f9a7d2bfbf9122b"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_sub32" ref="g2504e42aaef47c770f9a7d2bfbf9122b" args="(volatile apr_uint32_t *mem, apr_uint32_t val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void apr_atomic_sub32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>val</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> atomically subtract 'val' from an apr_uint32_t <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>amount to subtract </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="g8e0f6b1ed6b8fa8a091affe81c33a386"></a><!-- doxytag: member="apr_atomic.h::apr_atomic_xchg32" ref="g8e0f6b1ed6b8fa8a091affe81c33a386" args="(volatile apr_uint32_t *mem, apr_uint32_t val)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_uint32_t apr_atomic_xchg32 </td> <td>(</td> <td class="paramtype">volatile apr_uint32_t * </td> <td class="paramname"> <em>mem</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_uint32_t </td> <td class="paramname"> <em>val</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> exchange an apr_uint32_t's value with 'val'. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mem</em> </td><td>pointer to the value </td></tr> <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>what to swap it with </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>the old value of *mem </dd></dl> </div> </div><p> <hr size="1"><address style="align: right;"><small>Generated on Tue May 31 12:43:38 2011 for Apache Portable Runtime by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address> </body> </html>