<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>xrootd: XrdSysXSLock.hh Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">xrootd </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_d751caa81ddb88473173cbaf15e76961.html">XrdSys</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">XrdSysXSLock.hh</div> </div> </div><!--header--> <div class="contents"> <a href="XrdSysXSLock_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __SYS_XSLOCK_HH__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor"></span><span class="preprocessor">#define __SYS_XSLOCK_HH__</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor"></span><span class="comment">/******************************************************************************/</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/* X r d S y s X S L o c k . h h */</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/* (c) 2003 by the Board of Trustees of the Leland Stanford, Jr., University */</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* All Rights Reserved */</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* Produced by Andrew Hanushevsky for Stanford University under contract */</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* DE-AC02-76-SFO0515 with the Department of Energy */</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/* This file is part of the XRootD software suite. */</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/* XRootD is free software: you can redistribute it and/or modify it under */</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/* the terms of the GNU Lesser General Public License as published by the */</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/* Free Software Foundation, either version 3 of the License, or (at your */</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/* option) any later version. */</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/* XRootD is distributed in the hope that it will be useful, but WITHOUT */</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* License for more details. */</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* You should have received a copy of the GNU Lesser General Public License */</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* */</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* The copyright holder's institutional names and contributor's names may not */</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/* be used to endorse or promote products derived from this software without */</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/* specific prior written permission of the institution or contributor. */</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">/******************************************************************************/</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <errno.h></span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="XrdSysPthread_8hh.html">XrdSys/XrdSysPthread.hh</a>"</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// These are valid usage options</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//</span></div> <div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7daeb539a0a2533243aa0ef9a680ba40d03"> 38</a></span> <span class="keyword">enum</span> <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7d">XrdSysXS_Type</a> {<a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7da74fb6fceed141cbf778351e83f949e99">xs_None</a> = 0, <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7daeb539a0a2533243aa0ef9a680ba40d03">xs_Shared</a> = 1, <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7da26cffd4de201cdb2c67366045f7055b7">xs_Exclusive</a> = 2};</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// This class implements the shared lock. Any number of readers are allowed</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// by requesting a shared lock. Only one exclusive writer is allowed by</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// requesting an exclusive lock. Up/downgrading is not supported.</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">//</span></div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classXrdSysXSLock.html">XrdSysXSLock</a></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysXSLock.html#a007d88a36f5fcff2d6ca459d04cdc13b">Lock</a>(<span class="keyword">const</span> <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7d">XrdSysXS_Type</a> usage);</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code" href="classXrdSysXSLock.html#a026850f4faa02aca29b407d3117ff126">UnLock</a>(<span class="keyword">const</span> <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7d">XrdSysXS_Type</a> usage=<a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7da74fb6fceed141cbf778351e83f949e99">xs_None</a>);</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a38f006e94e301c605982e9ddafbcaf66"> 52</a></span>  <a class="code" href="classXrdSysXSLock.html#a38f006e94e301c605982e9ddafbcaf66">XrdSysXSLock</a>() : <a class="code" href="classXrdSysXSLock.html#a1b0929baebd8f186997cdf281decf953">cur_usage</a>(<a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7da74fb6fceed141cbf778351e83f949e99">xs_None</a>), <a class="code" href="classXrdSysXSLock.html#a97a3198bc170224d2b46ab649e815c6c">cur_count</a>(0), <a class="code" href="classXrdSysXSLock.html#a52bef96f69b47088e1101a6f3b0890a7">exc_wait</a>(0),</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classXrdSysXSLock.html#a770a2f3cf0be9a283c117e97a3c161f9">shr_wait</a>(0), <a class="code" href="classXrdSysXSLock.html#a85931a21b692f3f587784378b6fe08da">toggle</a>(0), <a class="code" href="classXrdSysXSLock.html#adccde4629abc93e9af42dca55900b892">WantShr</a>(0), <a class="code" href="classXrdSysXSLock.html#a88a2f7ae486fa16e1413e3327b925f22">WantExc</a>(0) {}</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classXrdSysXSLock.html#a64af156cf54660c3610602044fc18ee8">~XrdSysXSLock</a>();</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> <div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a1b0929baebd8f186997cdf281decf953"> 58</a></span> <a class="code" href="XrdSysXSLock_8hh.html#ab83d98558f67c60e10b9afb809b11a7d">XrdSysXS_Type</a> <a class="code" href="classXrdSysXSLock.html#a1b0929baebd8f186997cdf281decf953">cur_usage</a>;</div> <div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a97a3198bc170224d2b46ab649e815c6c"> 59</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysXSLock.html#a97a3198bc170224d2b46ab649e815c6c">cur_count</a>;</div> <div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a52bef96f69b47088e1101a6f3b0890a7"> 60</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysXSLock.html#a52bef96f69b47088e1101a6f3b0890a7">exc_wait</a>;</div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a770a2f3cf0be9a283c117e97a3c161f9"> 61</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysXSLock.html#a770a2f3cf0be9a283c117e97a3c161f9">shr_wait</a>;</div> <div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a85931a21b692f3f587784378b6fe08da"> 62</a></span> <span class="keywordtype">int</span> <a class="code" href="classXrdSysXSLock.html#a85931a21b692f3f587784378b6fe08da">toggle</a>;</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> <div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a1a3fe9de66e41ced3d30f5ba612045f8"> 64</a></span> <a class="code" href="classXrdSysMutex.html">XrdSysMutex</a> <a class="code" href="classXrdSysXSLock.html#a1a3fe9de66e41ced3d30f5ba612045f8">LockContext</a>;</div> <div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#adccde4629abc93e9af42dca55900b892"> 65</a></span> <a class="code" href="classXrdSysSemaphore.html">XrdSysSemaphore</a> <a class="code" href="classXrdSysXSLock.html#adccde4629abc93e9af42dca55900b892">WantShr</a>;</div> <div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classXrdSysXSLock.html#a88a2f7ae486fa16e1413e3327b925f22"> 66</a></span> <a class="code" href="classXrdSysSemaphore.html">XrdSysSemaphore</a> <a class="code" href="classXrdSysXSLock.html#a88a2f7ae486fa16e1413e3327b925f22">WantExc</a>;</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> };</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>