%PDF- %PDF-
Mini Shell

Mini Shell

Direktori : /proc/self/root/usr/share/nagios/html/docs/
Upload File :
Create Path :
Current File : //proc/self/root/usr/share/nagios/html/docs/nsock_8h_source.html

<!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.5"/>
<title>Nagios: nsock.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">Nagios
   &#160;<span id="projectnumber">4.4.3</span>
   </div>
   <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">nsock.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="nsock_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="preprocessor">#ifndef LIBNAGIOS_NSOCK_H_INCLUDED</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define LIBNAGIOS_NSOCK_H_INCLUDED</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &lt;errno.h&gt;</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">/**</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * @file nsock.h</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * @brief Nagios socket helper library</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"> * This is a pretty stupid library, but since so many addons and</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * now Nagios core itself makes use of sockets, we might as well</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * have some simple wrappers for it that handle the most common</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * cases.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * @{</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="nsock_8h.html#a0719a5e25867170046a6ec49cfe83384">   17</a></span>&#160;<span class="preprocessor">#define NSOCK_EBIND    (-1)     </span><span class="comment">/**&lt; failed to bind() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="nsock_8h.html#aaf7eb022fc5569eac2294a3cc5af3d94">   18</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_ELISTEN  (-2)     </span><span class="comment">/**&lt; failed to listen() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="nsock_8h.html#ac4c2490a03d1859f9205c10b16f2d7c2">   19</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_ESOCKET  (-3)     </span><span class="comment">/**&lt; failed to socket() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="nsock_8h.html#aa4cc22bbcfa712fddb19d3e5ea9f3279">   20</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_EUNLINK  (-4)     </span><span class="comment">/**&lt; failed to unlink() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="nsock_8h.html#ab5f8bab82e8bc81764892b297e716ac7">   21</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_ECONNECT (-5)     </span><span class="comment">/**&lt; failed to connect() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="nsock_8h.html#a898349e46105dfde23bc44c998c882b7">   22</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_EFCNTL   (-6)     </span><span class="comment">/**&lt; failed to fcntl() */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="nsock_8h.html#a6af373c87237b1ae9b8daa40cca9d48a">   23</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_EINVAL (-EINVAL) </span><span class="comment">/**&lt; -22, normally */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">/* flags for the various create calls */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="nsock_8h.html#aaa52ee91165aeea3d09b1d857b6b4426">   26</a></span>&#160;<span class="preprocessor">#define NSOCK_TCP     (1 &lt;&lt; 0)  </span><span class="comment">/**&lt; use tcp mode */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="nsock_8h.html#a114497e2b62c538aa90760a15559a7be">   27</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_UDP     (1 &lt;&lt; 1)  </span><span class="comment">/**&lt; use udp mode */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="nsock_8h.html#a71aae04fe3edaa4032791957b97f21d7">   28</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_UNLINK  (1 &lt;&lt; 2)  </span><span class="comment">/**&lt; unlink existing path (only nsock_unix) */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="nsock_8h.html#a85e3414ae9a0618e6bc873b205e0f572">   29</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_REUSE   (1 &lt;&lt; 2)  </span><span class="comment">/**&lt; reuse existing address */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="nsock_8h.html#a408ebfcac776e538f3b8ef3d7297d3c4">   30</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_CONNECT (1 &lt;&lt; 3)  </span><span class="comment">/**&lt; connect rather than create */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="nsock_8h.html#a7eff0af0a004baf44aad5c7c4a1e5b47">   31</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define NSOCK_BLOCK   (1 &lt;&lt; 4)  </span><span class="comment">/**&lt; socket should be in blocking mode */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * Grab an error string relating to nsock_unix()</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * @param code The error code return by the nsock library</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> * @return An error string describing the error</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="nsock_8h.html#adcaaf011dcd99b0d782cc2b89736f2cf">nsock_strerror</a>(<span class="keywordtype">int</span> code);</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"> * Create or connect to a unix socket</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"> * To control permissions on sockets when NSOCK_LISTEN is specified,</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"> * callers will have to modify their umask() before (and possibly</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"> * after) the nsock_unix() call.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> * @param path The path to connect to or create</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> * @param flags Various options controlling the mode of the socket</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * @return An NSOCK_E macro on errors, the created socket on success</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="nsock_8h.html#a698ebbdfe5e3589dd9e2d466d87ceb5a">nsock_unix</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> * Write a nul-terminated message to the socket pointed to by sd.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> * This isn&#39;t quite the same as dprintf(), which doesn&#39;t include</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> * the terminating nul byte.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> * @note This function may block, so poll(2) for writability</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * @param sd The socket to write to</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @param fmt The format string</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> * @return Whatever write() returns</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="nsock_8h.html#a0469978df30212122748624f95e9c472">nsock_printf_nul</a>(<span class="keywordtype">int</span> sd, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    __attribute__((__format__(__printf__, 2, 3)));</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * Write a printf()-formatted string to the socket pointed to by sd.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * This is identical to dprintf(), which is unfortunately GNU only.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> * @note This function may block, so poll(2) for writability</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * @param sd The socket to write to</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> * @param fmt The format string</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> * @return Whatever write() returns</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;extern <span class="keywordtype">int</span> <a class="code" href="nsock_8h.html#a64d3bcce8f97099cacceb6f11bbbc52a">nsock_printf</a>(<span class="keywordtype">int</span> sd, const <span class="keywordtype">char</span> *fmt, ...)</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    __attribute__((__format__(__printf__, 2, 3)));</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">/** @} */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* LIBNAGIOS_NSOCK_H_INCLUDED */</span><span class="preprocessor"></span></div>
<div class="ttc" id="nsock_8h_html_a698ebbdfe5e3589dd9e2d466d87ceb5a"><div class="ttname"><a href="nsock_8h.html#a698ebbdfe5e3589dd9e2d466d87ceb5a">nsock_unix</a></div><div class="ttdeci">int nsock_unix(const char *path, unsigned int flags)</div><div class="ttdoc">Create or connect to a unix socket To control permissions on sockets when NSOCK_LISTEN is specified...</div></div>
<div class="ttc" id="nsock_8h_html_a0469978df30212122748624f95e9c472"><div class="ttname"><a href="nsock_8h.html#a0469978df30212122748624f95e9c472">nsock_printf_nul</a></div><div class="ttdeci">int nsock_printf_nul(int sd, const char *fmt,...) __attribute__((__format__(__printf__</div><div class="ttdoc">Write a nul-terminated message to the socket pointed to by sd. </div></div>
<div class="ttc" id="nsock_8h_html_a64d3bcce8f97099cacceb6f11bbbc52a"><div class="ttname"><a href="nsock_8h.html#a64d3bcce8f97099cacceb6f11bbbc52a">nsock_printf</a></div><div class="ttdeci">int int nsock_printf(int sd, const char *fmt,...) __attribute__((__format__(__printf__</div><div class="ttdoc">Write a printf()-formatted string to the socket pointed to by sd. </div></div>
<div class="ttc" id="nsock_8h_html_adcaaf011dcd99b0d782cc2b89736f2cf"><div class="ttname"><a href="nsock_8h.html#adcaaf011dcd99b0d782cc2b89736f2cf">nsock_strerror</a></div><div class="ttdeci">const char * nsock_strerror(int code)</div><div class="ttdoc">Grab an error string relating to nsock_unix() </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>

Zerion Mini Shell 1.0