carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
							<!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.6"/>
<title>GRPC C++: include/grpc/support/thd.h 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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">GRPC C++
   &#160;<span id="projectnumber">1.8.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_cad3142e04109052413f2d2a2d1813b0.html">support</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">thd.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="thd_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2015 gRPC authors.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef GRPC_SUPPORT_THD_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_SUPPORT_THD_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="support_2port__platform_8h.html">grpc/support/port_platform.h</a>&gt;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="thd_8h.html#a568f2dcd15b98e9e93063eb04ad36a90">   36</a></span>&#160;<span class="keyword">typedef</span> uintptr_t <a class="code" href="thd_8h.html#a568f2dcd15b98e9e93063eb04ad36a90">gpr_thd_id</a>;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="structgpr__thd__options.html">   39</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structgpr__thd__options.html#aaa966777aca6604109eb4cd6cae7984c">   40</a></span>&#160;  <span class="keywordtype">int</span> <a class="code" href="structgpr__thd__options.html#aaa966777aca6604109eb4cd6cae7984c">flags</a>; </div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;} <a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="thd_8h.html#a1512fb59795f3c7acf6f1d25dd188a86">gpr_thd_new</a>(gpr_thd_id* t, <span class="keywordtype">void</span> (*thd_body)(<span class="keywordtype">void</span>* arg), <span class="keywordtype">void</span>* arg,</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;                       <span class="keyword">const</span> <a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>* options);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <a class="code" href="structgpr__thd__options.html">gpr_thd_options</a> <a class="code" href="thd_8h.html#ae568dd50aa735eb5b5bc9cd7f0a511b2">gpr_thd_options_default</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="thd_8h.html#a378bba9e91aea353a95cdf22bfca0e8f">gpr_thd_options_set_detached</a>(<a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>* options);</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="thd_8h.html#a2e7d20212eaad5c06a0cbd554eec01e9">gpr_thd_options_set_joinable</a>(<a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>* options);</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="thd_8h.html#a9733626e12522fd2f04095a2d4c61cf5">gpr_thd_options_is_detached</a>(<span class="keyword">const</span> <a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>* options);</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">int</span> <a class="code" href="thd_8h.html#a77574a5c01a28e81b8bdc0d2b9ffb6df">gpr_thd_options_is_joinable</a>(<span class="keyword">const</span> <a class="code" href="structgpr__thd__options.html">gpr_thd_options</a>* options);</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> gpr_thd_id <a class="code" href="thd_8h.html#a31f4f0f3d23991877b30e44a966d3306">gpr_thd_currentid</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<a class="code" href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a> <span class="keywordtype">void</span> <a class="code" href="thd_8h.html#a4735072c325ed1c09d1ca41033cdb362">gpr_thd_join</a>(gpr_thd_id t);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_SUPPORT_THD_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="thd_8h_html_ae568dd50aa735eb5b5bc9cd7f0a511b2"><div class="ttname"><a href="thd_8h.html#ae568dd50aa735eb5b5bc9cd7f0a511b2">gpr_thd_options_default</a></div><div class="ttdeci">GPRAPI gpr_thd_options gpr_thd_options_default(void)</div><div class="ttdoc">Return a gpr_thd_options struct with all fields set to defaults. </div></div>
<div class="ttc" id="impl_2codegen_2port__platform_8h_html_af89d3610372fc35178e83e06916aa808"><div class="ttname"><a href="impl_2codegen_2port__platform_8h.html#af89d3610372fc35178e83e06916aa808">GPRAPI</a></div><div class="ttdeci">#define GPRAPI</div><div class="ttdef"><b>Definition:</b> port_platform.h:440</div></div>
<div class="ttc" id="thd_8h_html_a1512fb59795f3c7acf6f1d25dd188a86"><div class="ttname"><a href="thd_8h.html#a1512fb59795f3c7acf6f1d25dd188a86">gpr_thd_new</a></div><div class="ttdeci">GPRAPI int gpr_thd_new(gpr_thd_id *t, void(*thd_body)(void *arg), void *arg, const gpr_thd_options *options)</div><div class="ttdoc">Create a new thread running (*thd_body)(arg) and place its thread identifier in *t, and return true. </div></div>
<div class="ttc" id="structgpr__thd__options_html_aaa966777aca6604109eb4cd6cae7984c"><div class="ttname"><a href="structgpr__thd__options.html#aaa966777aca6604109eb4cd6cae7984c">gpr_thd_options::flags</a></div><div class="ttdeci">int flags</div><div class="ttdef"><b>Definition:</b> thd.h:40</div></div>
<div class="ttc" id="thd_8h_html_a378bba9e91aea353a95cdf22bfca0e8f"><div class="ttname"><a href="thd_8h.html#a378bba9e91aea353a95cdf22bfca0e8f">gpr_thd_options_set_detached</a></div><div class="ttdeci">GPRAPI void gpr_thd_options_set_detached(gpr_thd_options *options)</div><div class="ttdoc">Set the thread to become detached on startup - this is the default. </div></div>
<div class="ttc" id="thd_8h_html_a31f4f0f3d23991877b30e44a966d3306"><div class="ttname"><a href="thd_8h.html#a31f4f0f3d23991877b30e44a966d3306">gpr_thd_currentid</a></div><div class="ttdeci">GPRAPI gpr_thd_id gpr_thd_currentid(void)</div><div class="ttdoc">Returns the identifier of the current thread. </div></div>
<div class="ttc" id="thd_8h_html_a568f2dcd15b98e9e93063eb04ad36a90"><div class="ttname"><a href="thd_8h.html#a568f2dcd15b98e9e93063eb04ad36a90">gpr_thd_id</a></div><div class="ttdeci">uintptr_t gpr_thd_id</div><div class="ttdoc">Thread interface for GPR. </div><div class="ttdef"><b>Definition:</b> thd.h:36</div></div>
<div class="ttc" id="thd_8h_html_a2e7d20212eaad5c06a0cbd554eec01e9"><div class="ttname"><a href="thd_8h.html#a2e7d20212eaad5c06a0cbd554eec01e9">gpr_thd_options_set_joinable</a></div><div class="ttdeci">GPRAPI void gpr_thd_options_set_joinable(gpr_thd_options *options)</div><div class="ttdoc">Set the thread to become joinable - mutually exclusive with detached. </div></div>
<div class="ttc" id="thd_8h_html_a4735072c325ed1c09d1ca41033cdb362"><div class="ttname"><a href="thd_8h.html#a4735072c325ed1c09d1ca41033cdb362">gpr_thd_join</a></div><div class="ttdeci">GPRAPI void gpr_thd_join(gpr_thd_id t)</div><div class="ttdoc">Blocks until the specified thread properly terminates. </div></div>
<div class="ttc" id="thd_8h_html_a9733626e12522fd2f04095a2d4c61cf5"><div class="ttname"><a href="thd_8h.html#a9733626e12522fd2f04095a2d4c61cf5">gpr_thd_options_is_detached</a></div><div class="ttdeci">GPRAPI int gpr_thd_options_is_detached(const gpr_thd_options *options)</div><div class="ttdoc">Returns non-zero if the option detached is set. </div></div>
<div class="ttc" id="structgpr__thd__options_html"><div class="ttname"><a href="structgpr__thd__options.html">gpr_thd_options</a></div><div class="ttdoc">Thread creation options. </div><div class="ttdef"><b>Definition:</b> thd.h:39</div></div>
<div class="ttc" id="thd_8h_html_a77574a5c01a28e81b8bdc0d2b9ffb6df"><div class="ttname"><a href="thd_8h.html#a77574a5c01a28e81b8bdc0d2b9ffb6df">gpr_thd_options_is_joinable</a></div><div class="ttdeci">GPRAPI int gpr_thd_options_is_joinable(const gpr_thd_options *options)</div><div class="ttdoc">Returns non-zero if the option joinable is set. </div></div>
<div class="ttc" id="support_2port__platform_8h_html"><div class="ttname"><a href="support_2port__platform_8h.html">port_platform.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>