1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>kernel_recvmsg</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Linux Networking and Network Devices APIs"><link rel="up" href="ch01s02.html" title="Socket Buffer Functions"><link rel="prev" href="API-sock-release.html" title="sock_release"><link rel="next" href="API-sock-register.html" title="sock_register"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">kernel_recvmsg</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-sock-release.html">Prev</a>&#160;</td><th width="60%" align="center">Socket Buffer Functions</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-sock-register.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kernel-recvmsg"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>kernel_recvmsg &#8212; 
2     Receive a message from a socket (kernel space)
3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">kernel_recvmsg </b>(</code></td><td>struct socket * <var class="pdparam">sock</var>, </td></tr><tr><td>&#160;</td><td>struct msghdr * <var class="pdparam">msg</var>, </td></tr><tr><td>&#160;</td><td>struct kvec * <var class="pdparam">vec</var>, </td></tr><tr><td>&#160;</td><td>size_t <var class="pdparam">num</var>, </td></tr><tr><td>&#160;</td><td>size_t <var class="pdparam">size</var>, </td></tr><tr><td>&#160;</td><td>int <var class="pdparam">flags</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1095966316"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sock</code></em></span></dt><dd><p>
4     The socket to receive the message from
5    </p></dd><dt><span class="term"><em class="parameter"><code>msg</code></em></span></dt><dd><p>
6     Received message
7    </p></dd><dt><span class="term"><em class="parameter"><code>vec</code></em></span></dt><dd><p>
8     Input s/g array for message data
9    </p></dd><dt><span class="term"><em class="parameter"><code>num</code></em></span></dt><dd><p>
10     Size of input s/g array
11    </p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
12     Number of bytes to read
13    </p></dd><dt><span class="term"><em class="parameter"><code>flags</code></em></span></dt><dd><p>
14     Message flags (MSG_DONTWAIT, etc...)
15    </p></dd></dl></div></div><div class="refsect1"><a name="idp1095972844"></a><h2>Description</h2><p>
16   On return the msg structure contains the scatter/gather array passed in the
17   vec argument. The array is modified so that it consists of the unfilled
18   portion of the original array.
19   </p><p>
20
21   The returned value is the total number of bytes received, or an error.
22</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-sock-release.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch01s02.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-sock-register.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">sock_release</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">sock_register</span></td></tr></table></div></body></html>
23