Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 9142

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Methods of Class DatagramSocket</title>
<link rel="stylesheet" type="text/css" href="../../../cpp.css">
</head>
<body>
<div id="adc-cppref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="1" cellspacing="0">
<tr align="center" valign="top">
<td class="navimain">&nbsp;<a href="../../../index.html">Overview</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../index.html">Namespace</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../c-DatagramSocket.html">Class</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../index-files/index-1.html">Index</a>&nbsp;</td>
<td class="navimain">&nbsp;<a href="../../../help.html">Help</a>&nbsp;</td>
</tr>
</table>
<table class="navisub" cellpadding="0" cellspacing="3"></table>
<hr>
<div class="title"><h2>Methods of Class DatagramSocket</h2>
</div><hr>
<dl class="member">
<dt class="member"><a name="DatagramSocket-217"> </a>DatagramSocket</dt>
<dd class="member"><dl>
<dt class="simple"> <strong>DatagramSocket</strong>(</dt>
<dd><table class="param-table">
<tr>
<td><a href="../../t-oslAddrFamily.html">oslAddrFamily</a> </td>
<td> Family = osl_Socket_FamilyInet,</td>
</tr>
<tr>
<td><a href="../../t-oslProtocol.html">oslProtocol</a></td>
<td>Protocol = osl_Socket_ProtocolIp,</td>
</tr>
<tr>
<td><a href="../../t-oslSocketType.html">oslSocketType</a></td>
<td>Type = osl_Socket_TypeDgram );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Creates a datagram socket.
</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">Type</td>
<td><pre>is sock_dgram by default.
</pre></td>
</tr>
</table>
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="recvFrom-218"> </a>recvFrom</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>recvFrom</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>void * </td>
<td> pBuffer,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt32.html">sal_uInt32</a></td>
<td>BufferSize,</td>
</tr>
<tr>
<td><a href="../../osl/c-SocketAddr.html">SocketAddr</a> *</td>
<td>pSenderAddr = 0,</td>
</tr>
<tr>
<td><a href="../../t-oslSocketMsgFlag.html">oslSocketMsgFlag</a></td>
<td>Flag = osl_Socket_MsgNormal );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Summary</dt>
<dd>Tries to receives BufferSize data from the socket, if no error occurs. 

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pSenderAddr</td>
<td><pre>You must provide pointer to a SocketAddr.
It will be    filled with the address of the datagrams sender. 
If pSenderAddr is 0, it is ignored.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td>
<td><pre>Points to a buffer that will be filled with the received 
datagram.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">BufferSize</td>
<td><pre>The size of pBuffer.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">Flag</td>
<td><pre>Modifier for the call. Valid values are:
<ul>
<li><code>osl_Socket_MsgNormal</code>
<li><code>osl_Socket_MsgOOB</code>
<li><code>osl_Socket_MsgPeek</code>
<li><code>osl_Socket_MsgDontRoute</code>
<li><code>osl_Socket_MsgMaxIOVLen</code>
</ul>

</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>the number of received bytes.
</dd>
</dl>
</dd>
</dl>
<hr>
<dl class="member">
<dt class="member"><a name="sendTo-219"> </a>sendTo</dt>
<dd class="member"><dl>
<dt class="simple"><a href="../../t-sal_Int32.html">sal_Int32</a> <strong>sendTo</strong>(</dt>
<dd><table class="param-table">
<tr>
<td>const <a href="../../osl/c-SocketAddr.html">SocketAddr</a> &amp; </td>
<td> ReceiverAddr,</td>
</tr>
<tr>
<td>const void *</td>
<td>pBuffer,</td>
</tr>
<tr>
<td><a href="../../t-sal_uInt32.html">sal_uInt32</a></td>
<td>BufferSize,</td>
</tr>
<tr>
<td><a href="../../t-oslSocketMsgFlag.html">oslSocketMsgFlag</a></td>
<td>Flag = osl_Socket_MsgNormal );</td>
</tr>
</table>
</dd>
</dl>
<br>
</dd>
<dd class="member"><table class="flag-table" border="1" cellspacing="0">
<tr>
<td width="12%" class="flagname">virtual</td>
<td width="12%" class="flagname">abstract</td>
<td width="12%" class="flagname">const</td>
<td width="12%" class="flagname">volatile</td>
<td width="12%" class="flagname">template</td>
<td width="12%" class="flagname">static</td>
<td width="12%" class="flagname">inline</td>
<td width="12%" class="flagname">C-linkage</td>
</tr>
<tr>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagno">NO</td>
<td class="flagyes">YES</td>
<td class="flagno">NO</td>
</tr>
</table>
<br>
</dd>
<dd class="member"><dl>
<dt>Description</dt>
<dd>Tries to send one datagram with BytesToSend size to the given ReceiverAddr.
Since there is only send one packet, the function doesn't care about
packet boundaries.

</dd>
<dt>Parameters</dt>
<dd><table border="0" width="100%" cellpadding="3" cellspacing="0" class="expl-table">
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">ReceiverAddr</td>
<td><pre>A SocketAddr that contains
the destination address for this send. 

</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">pBuffer</td>
<td><pre>Points to a buffer that contains the send-data.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">BufferSize</td>
<td><pre>The number of bytes to send. pBuffer must have at least
this size.
</pre></td>
</tr>
<tr>
<td width="15%" style="vertical-align:top; font-weight:bold">Flag</td>
<td><pre>Modifier for the call. Valid values are:

<ul>
<li><code>osl_Socket_MsgNormal</code>
<li><code>osl_Socket_MsgOOB</code>
<li><code>osl_Socket_MsgPeek</code>
<li><code>osl_Socket_MsgDontRoute</code>
<li><code>osl_Socket_MsgMaxIOVLen</code>
</ul>

</pre></td>
</tr>
</table>
</dd>
<dt>Return</dt>
<dd>the number of transfered bytes.
</dd>
</dl>
</dd>
</dl>
<hr>
<a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-cppref" -->
</body>

</html>