1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../css/manpage.css" type="text/css" />
7<title>SockAtMark</title>
8  </head>
9  <body>
10<h1><CODE>nn::socket::SockAtMark</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14s32 SockAtMark(
15     s32 s
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>s</th>
32<td>Specifies the socket descriptor. Specify a socket descriptor created using the <a href="../../nn/socket/Socket.html"><CODE>Socket</CODE></a> or <a href="../../nn/socket/Accept.html"><CODE>Accept</CODE></a> function.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36    <div class="section">
37      <br /> <br />
38      <table class="arguments">
39        <thead>
40          <tr>
41<th>Value</th>
42<td>Description</td>
43          </tr>
44        </thead>
45        <tr>
46          <th>1</th>
47<td>A mark has been made indicating the socket has received out-of-band data. You can read the out-of-band data by calling the <a href="../../nn/socket/Recv.html"><CODE>Recv</CODE></a> function with <CODE>MSG_OOB</CODE> specified right after you call this function. If the protocol is TCP, this indicates that the last byte of urgent data exists at the start of the readable buffer.</td>
48        </tr>
49        <tr>
50          <th>0</th>
51<td>No mark has been made indicating that out-of-band data has been received by the socket. If the protocol is TCP, note that the existence of urgent data cannot be detected until the start of the readable buffer assumes the value of the last byte of TCP urgent data.</td>
52        </tr>
53        <tr>
54<th><CODE>ENETRESET</CODE></th>
55<td>Socket library is not initialized.</td>
56        </tr>
57        <tr>
58<th><CODE>EBADF</CODE></th>
59<td>Invalid socket descriptor.</td>
60        </tr>
61        <tr>
62<th><CODE>EINVAL</CODE></th>
63<td>Invalid processing.</td>
64        </tr>
65      </table> </div>
66<h2>Description</h2>
67    <div class="section">
68<p>Determines whether the specified socket has an out-of-band data mark.</p><p>This can be used to check whether the start of the socket's readable buffer is the last byte of TCP urgent data.</p><!-- write here --></div>
69<h2>See Also</h2>
70    <div class="section">
71<p class="reference"><a href="../../nn/socket/Recv.html"><CODE>Recv</CODE></a>, <a href="../../nn/socket/RecvFrom.html"><CODE>RecvFrom</CODE></a><br /> </p>
72    </div>
73<h2>Revision History</h2>
74    <div class="section">
75      <dl class="history">
76        <dt>2010/06/14</dt>
77<dd>Initial version.<br />
78        </dd>
79      </dl>
80    </div>
81  <hr><p>CONFIDENTIAL</p></body>
82</html>