/usr/share/gtk-doc/html/libinfinity-0.6/libinfinity-0.6-InfNativeSocket.html is in libinfinity-0.6-doc 0.6.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfNativeSocket: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="libinfinity-0.6-InfProtocol.html" title="InfProtocol">
<link rel="next" href="InfBuffer.html" title="InfBuffer">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libinfinity-0.6-InfNativeSocket.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libinfinity-0.6-InfProtocol.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfBuffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libinfinity-0.6-InfNativeSocket"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinity-0.6-InfNativeSocket.top_of_page"></a>InfNativeSocket</span></h2>
<p>InfNativeSocket — Uniform access to the BSD socket API</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GQuark</span>
</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfNativeSocket.html#inf-native-socket-error-quark" title="inf_native_socket_error_quark ()">inf_native_socket_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfNativeSocket.html#inf-native-socket-make-error" title="inf_native_socket_make_error ()">inf_native_socket_make_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfNativeSocket.html#closesocket" title="closesocket()">closesocket</a><span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="InfIo.html#InfNativeSocket" title="InfNativeSocket">InfNativeSocket</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-EAGAIN:CAPS" title="INF_NATIVE_SOCKET_EAGAIN">INF_NATIVE_SOCKET_EAGAIN</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-EINPROGRESS:CAPS" title="INF_NATIVE_SOCKET_EINPROGRESS">INF_NATIVE_SOCKET_EINPROGRESS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-EINTR:CAPS" title="INF_NATIVE_SOCKET_EINTR">INF_NATIVE_SOCKET_EINTR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-LAST-ERROR:CAPS" title="INF_NATIVE_SOCKET_LAST_ERROR">INF_NATIVE_SOCKET_LAST_ERROR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-SENDRECV-FLAGS:CAPS" title="INF_NATIVE_SOCKET_SENDRECV_FLAGS">INF_NATIVE_SOCKET_SENDRECV_FLAGS</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libinfinity-0.6-InfNativeSocket.html#INVALID-SOCKET:CAPS" title="INVALID_SOCKET">INVALID_SOCKET</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-native-socket.h>
</pre>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.description"></a><h2>Description</h2>
<p>This module provides a common way to access the BSD socket API. While
the API is mostly equivalent on Linux and Windows, there are some subtle
differences for which uniform identifiers are provided.</p>
<p>Before <a class="link" href="InfIo.html#InfNativeSocket" title="InfNativeSocket"><span class="type">InfNativeSocket</span></a> can be used, on Windows WinSock2 must be
initialized. You can either do this manually, or call <a class="link" href="libinfinity-0.6-InfInit.html#inf-init" title="inf_init ()"><code class="function">inf_init()</code></a> which
does it for you.</p>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-native-socket-error-quark"></a><h3>inf_native_socket_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>
inf_native_socket_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a <span class="type">GQuark</span> representing the INF_NATIVE_SOCKET_ERROR domain.</p>
<div class="refsect3">
<a name="inf-native-socket-error-quark.returns"></a><h4>Returns</h4>
<p> A <span class="type">GQuark</span> representing the INF_NATIVE_SOCKET_ERROR domain.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-native-socket-make-error"></a><h3>inf_native_socket_make_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_native_socket_make_error (<em class="parameter"><code><span class="type">int</span> code</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts the platform-dependent error code <em class="parameter"><code>code</code></em>
into a <span class="type">GError</span>. The
<span class="type">GError</span> will contain the same numerical value and a platform-dependent
human-readable error message.</p>
<div class="refsect3">
<a name="inf-native-socket-make-error.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>code</p></td>
<td class="parameter_description"><p>An error code obtained with <a class="link" href="libinfinity-0.6-InfNativeSocket.html#INF-NATIVE-SOCKET-LAST-ERROR:CAPS" title="INF_NATIVE_SOCKET_LAST_ERROR"><span class="type">INF_NATIVE_SOCKET_LAST_ERROR</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="closesocket"></a><h3>closesocket()</h3>
<pre class="programlisting"># define closesocket(s) close(s)
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfNativeSocket.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfNativeSocket"></a><h3>InfNativeSocket</h3>
<pre class="programlisting">typedef SOCKET InfNativeSocket;
</pre>
<p>Native socket type on the target platform. This typedef is a simple <span class="type">int</span>
on Unix and a <span class="type">SOCKET</span> on Windows.</p>
</div>
<hr>
<div class="refsect2">
<a name="INF-NATIVE-SOCKET-EAGAIN:CAPS"></a><h3>INF_NATIVE_SOCKET_EAGAIN</h3>
<pre class="programlisting"># define INF_NATIVE_SOCKET_EAGAIN WSAEWOULDBLOCK
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="INF-NATIVE-SOCKET-EINPROGRESS:CAPS"></a><h3>INF_NATIVE_SOCKET_EINPROGRESS</h3>
<pre class="programlisting"># define INF_NATIVE_SOCKET_EINPROGRESS WSAEWOULDBLOCK
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="INF-NATIVE-SOCKET-EINTR:CAPS"></a><h3>INF_NATIVE_SOCKET_EINTR</h3>
<pre class="programlisting"># define INF_NATIVE_SOCKET_EINTR WSAEINTR
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="INF-NATIVE-SOCKET-LAST-ERROR:CAPS"></a><h3>INF_NATIVE_SOCKET_LAST_ERROR</h3>
<pre class="programlisting"># define INF_NATIVE_SOCKET_LAST_ERROR WSAGetLastError()
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="INF-NATIVE-SOCKET-SENDRECV-FLAGS:CAPS"></a><h3>INF_NATIVE_SOCKET_SENDRECV_FLAGS</h3>
<pre class="programlisting"># define INF_NATIVE_SOCKET_SENDRECV_FLAGS 0
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="INVALID-SOCKET:CAPS"></a><h3>INVALID_SOCKET</h3>
<pre class="programlisting"># define INVALID_SOCKET -1
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|