<!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.8"/>
<title>pcsc-lite: sd-daemon.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="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">pcsc-lite
 <span id="projectnumber">1.8.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 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>Globals</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">sd-daemon.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#ifndef foosddaemonhfoo</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#define foosddaemonhfoo</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</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"> Copyright 2010 Lennart Poettering</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Permission is hereby granted, free of charge, to any person</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> obtaining a copy of this software and associated documentation files</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> (the "Software"), to deal in the Software without restriction,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> including without limitation the rights to use, copy, modify, merge,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> publish, distribute, sublicense, and/or sell copies of the Software,</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> and to permit persons to whom the Software is furnished to do so,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> subject to the following conditions:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> The above copyright notice and this permission notice shall be</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> included in all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> SOFTWARE.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">***/</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <sys/types.h></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <inttypes.h></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">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</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"> 38</span> <span class="comment"> Reference implementation of a few systemd related interfaces for</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> writing daemons. These interfaces are trivial to implement. To</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> simplify porting we provide this reference implementation.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Applications are welcome to reimplement the algorithms described</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> here if they do not want to include these two source files.</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"> 44</span> <span class="comment"> The following functionality is provided:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> - Support for logging with log levels on stderr</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> - File descriptor passing for socket-based activation</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> - Daemon startup and status notification</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> - Detection of systemd boots</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> You may compile this with -DDISABLE_SYSTEMD to disable systemd</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> support. This makes all those calls NOPs that are directly related to</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> systemd (i.e. only sd_is_xxx() will stay useful).</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> Since this is drop-in code we don't want any of our symbols to be</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> exported in any case. Hence we declare hidden visibility for all of</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> them.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> You may find an up-to-date version of these source files online:</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> http://cgit.freedesktop.org/systemd/plain/src/sd-daemon.h</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> http://cgit.freedesktop.org/systemd/plain/src/sd-daemon.c</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> This should compile on non-Linux systems, too, but with the</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> exception of the sd_is_xxx() calls all functions will become NOPs.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> See sd-daemon(7) for more information.</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#ifndef _sd_printf_attr_</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#if __GNUC__ >= 4</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#define _sd_printf_attr_(a,b) __attribute__ ((format (printf, a, b)))</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#define _sd_printf_attr_(a,b)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> Log levels for usage on stderr:</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> fprintf(stderr, SD_NOTICE "Hello World!\n");</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> This is similar to printk() usage in the kernel.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#define SD_EMERG "<0>" </span><span class="comment">/* system is unusable */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#define SD_ALERT "<1>" </span><span class="comment">/* action must be taken immediately */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#define SD_CRIT "<2>" </span><span class="comment">/* critical conditions */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#define SD_ERR "<3>" </span><span class="comment">/* error conditions */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#define SD_WARNING "<4>" </span><span class="comment">/* warning conditions */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#define SD_NOTICE "<5>" </span><span class="comment">/* normal but significant condition */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#define SD_INFO "<6>" </span><span class="comment">/* informational */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#define SD_DEBUG "<7>" </span><span class="comment">/* debug-level messages */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/* The first passed file descriptor is fd 3 */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#define SD_LISTEN_FDS_START 3</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> Returns how many file descriptors have been passed, or a negative</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> errno code on failure. Optionally, removes the $LISTEN_FDS and</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> $LISTEN_PID file descriptors from the environment (recommended, but</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> problematic in threaded environments). If r is the return value of</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> this function you'll find the file descriptors passed as fds</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> SD_LISTEN_FDS_START to SD_LISTEN_FDS_START+r-1. Returns a negative</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> errno style error code on failure. This function call ensures that</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> the FD_CLOEXEC flag is set for the passed file descriptors, to make</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> sure they are not passed on to child processes. If FD_CLOEXEC shall</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> not be set, the caller needs to unset it after this call for all file</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> descriptors that are used.</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> See sd_listen_fds(3) for more information.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keywordtype">int</span> sd_listen_fds(<span class="keywordtype">int</span> unset_environment);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> the file descriptor is a FIFO in the file system stored under the</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> specified path, 0 otherwise. If path is NULL a path name check will</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> not be done and the call only verifies if the file descriptor</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> refers to a FIFO. Returns a negative errno style error code on</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> failure.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"></span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> See sd_is_fifo(3) for more information.</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keywordtype">int</span> sd_is_fifo(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> the file descriptor is a special character device on the file</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> system stored under the specified path, 0 otherwise.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> If path is NULL a path name check will not be done and the call</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> only verifies if the file descriptor refers to a special character.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> Returns a negative errno style error code on failure.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> See sd_is_special(3) for more information.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">int</span> sd_is_special(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> the file descriptor is a socket of the specified family (AF_INET,</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> ...) and type (SOCK_DGRAM, SOCK_STREAM, ...), 0 otherwise. If</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> family is 0 a socket family check will not be done. If type is 0 a</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> socket type check will not be done and the call only verifies if</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> the file descriptor refers to a socket. If listening is > 0 it is</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> verified that the socket is in listening mode. (i.e. listen() has</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> been called) If listening is == 0 it is verified that the socket is</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> not in listening mode. If listening is < 0 no listening mode check</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> is done. Returns a negative errno style error code on failure.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> See sd_is_socket(3) for more information.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="keywordtype">int</span> sd_is_socket(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> family, <span class="keywordtype">int</span> type, <span class="keywordtype">int</span> listening);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> the file descriptor is an Internet socket, of the specified family</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> (either AF_INET or AF_INET6) and the specified type (SOCK_DGRAM,</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> SOCK_STREAM, ...), 0 otherwise. If version is 0 a protocol version</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> check is not done. If type is 0 a socket type check will not be</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> done. If port is 0 a socket port check will not be done. The</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> listening flag is used the same way as in sd_is_socket(). Returns a</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> negative errno style error code on failure.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"></span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> See sd_is_socket_inet(3) for more information.</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">int</span> sd_is_socket_inet(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> family, <span class="keywordtype">int</span> type, <span class="keywordtype">int</span> listening, uint16_t port);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> the file descriptor is an AF_UNIX socket of the specified type</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> (SOCK_DGRAM, SOCK_STREAM, ...) and path, 0 otherwise. If type is 0</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> a socket type check will not be done. If path is NULL a socket path</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> check will not be done. For normal AF_UNIX sockets set length to</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> 0. For abstract namespace sockets set length to the length of the</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> socket name (including the initial 0 byte), and pass the full</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> socket path in path (including the initial 0 byte). The listening</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> flag is used the same way as in sd_is_socket(). Returns a negative</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> errno style error code on failure.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> See sd_is_socket_unix(3) for more information.</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keywordtype">int</span> sd_is_socket_unix(<span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> type, <span class="keywordtype">int</span> listening, <span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> Helper call for identifying a passed file descriptor. Returns 1 if</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> the file descriptor is a POSIX Message Queue of the specified name,</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> 0 otherwise. If path is NULL a message queue name check is not</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> done. Returns a negative errno style error code on failure.</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="keywordtype">int</span> sd_is_mq(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> Informs systemd about changed daemon state. This takes a number of</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> newline separated environment-style variable assignments in a</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> string. The following variables are known:</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> READY=1 Tells systemd that daemon startup is finished (only</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> relevant for services of Type=notify). The passed</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> argument is a boolean "1" or "0". Since there is</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> little value in signaling non-readiness the only</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> value daemons should send is "READY=1".</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"></span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> STATUS=... Passes a single-line status string back to systemd</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> that describes the daemon state. This is free-from</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> and can be used for various purposes: general state</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> feedback, fsck-like programs could pass completion</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> percentages and failing programs could pass a human</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> readable error message. Example: "STATUS=Completed</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> 66% of file system check..."</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"></span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> ERRNO=... If a daemon fails, the errno-style error code,</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> formatted as string. Example: "ERRNO=2" for ENOENT.</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> BUSERROR=... If a daemon fails, the D-Bus error-style error</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> code. Example: "BUSERROR=org.freedesktop.DBus.Error.TimedOut"</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"></span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> MAINPID=... The main pid of a daemon, in case systemd did not</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> fork off the process itself. Example: "MAINPID=4711"</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"></span></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> Daemons can choose to send additional variables. However, it is</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> recommended to prefix variable names not listed above with X_.</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> Returns a negative errno-style error code on failure. Returns > 0</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> if systemd could be notified, 0 if it couldn't possibly because</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> systemd is not running.</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"></span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> Example: When a daemon finished starting up, it could issue this</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> call to notify systemd about it:</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"></span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> sd_notify(0, "READY=1");</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"></span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> See sd_notifyf() for more complete examples.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"></span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> See sd_notify(3) for more information.</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keywordtype">int</span> sd_notify(<span class="keywordtype">int</span> unset_environment, <span class="keyword">const</span> <span class="keywordtype">char</span> *state);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> Similar to sd_notify() but takes a format string.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"></span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> Example 1: A daemon could send the following after initialization:</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"></span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> sd_notifyf(0, "READY=1\n"</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> "STATUS=Processing requests...\n"</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> "MAINPID=%lu",</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> (unsigned long) getpid());</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"></span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> Example 2: A daemon could send the following shortly before</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> exiting, on failure:</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"></span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> sd_notifyf(0, "STATUS=Failed to start up: %s\n"</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> "ERRNO=%i",</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> strerror(errno),</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> errno);</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"></span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> See sd_notifyf(3) for more information.</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="keywordtype">int</span> sd_notifyf(<span class="keywordtype">int</span> unset_environment, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...) _sd_printf_attr_(2,3);</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> Returns > 0 if the system was booted with systemd. Returns < 0 on</span></div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> error. Returns 0 if the system was not booted with systemd. Note</span></div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> that all of the functions above handle non-systemd boots just</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> fine. You should NOT protect them with a call to this function. Also</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> note that this function checks whether the system, not the user</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> session is controlled by systemd. However the functions above work</span></div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> for both user and system services.</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"></span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> See sd_booted(3) for more information.</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="keywordtype">int</span> sd_booted(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> }</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 15 2014 11:57:56 for pcsc-lite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
8db5617ff88aacc3075d0be1db459900
>
files
>
148
