~ubuntu-branches/ubuntu/trusty/glibmm2.4/trusty-proposed

 <tr style="height: 56px;">

  <td style="padding-left: 0.5em;">

   <div id="projectname">glibmm

   </div>

  </td>

 </tr>

<tr class="memdesc:a16044bba5924c183cff90f0a4cf47394"><td class="mdescLeft">&#160;</td><td class="mdescRight">When a socket is created it is attached to an address family, but it doesn't have an address in this family.  <a href="#a16044bba5924c183cff90f0a4cf47394">More...</a><br/></td></tr>

<tr class="separator:a16044bba5924c183cff90f0a4cf47394"><td class="memSeparator" colspan="2">&#160;</td></tr>

<tr class="memitem:af16eed3fd42f3769b5e608f96db214fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Socket.html#af16eed3fd42f3769b5e608f96db214fd">listen</a> ()</td></tr>

<tr class="separator:af16eed3fd42f3769b5e608f96db214fd"><td class="memSeparator" colspan="2">&#160;</td></tr>

<tr class="memitem:a137ae34a8f211eaed11f9a58ca6b3f5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Socket.html">Socket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Socket.html#a137ae34a8f211eaed11f9a58ca6b3f5e">accept</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp; cancellable)</td></tr>

<tr class="memdesc:a137ae34a8f211eaed11f9a58ca6b3f5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Accept incoming connections on a connection-based socket.  <a href="#a137ae34a8f211eaed11f9a58ca6b3f5e">More...</a><br/></td></tr>

<tr class="memitem:ad350079b590c05387736a0fd21e6e0ec"><td class="memItemLeft" align="right" valign="top">gssize&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Socket.html#ad350079b590c05387736a0fd21e6e0ec">send_with_blocking</a> (gchar* buffer, gsize <a class="elRef" doxygen="/opt/gnome/share/mm-common/doctags/libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01651.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, bool blocking, const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;&amp; cancellable=<a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGio_1_1Cancellable.html">Cancellable</a> &gt;())</td></tr>

<tr class="memdesc:ad350079b590c05387736a0fd21e6e0ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">This behaves exactly the same as g_socket_send(), except that the choice of blocking or non-blocking behavior is determined by the <em>blocking</em> argument rather than by <em>socket's</em> properties.  <a href="#ad350079b590c05387736a0fd21e6e0ec">More...</a><br/></td></tr>

<tr class="separator:ad350079b590c05387736a0fd21e6e0ec"><td class="memSeparator" colspan="2">&#160;</td></tr>

<tr class="memitem:a8161abb1b8367aed9502d48be2d94172"><td class="memItemLeft" align="right" valign="top">guint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Socket.html#a8161abb1b8367aed9502d48be2d94172">get_ttl</a> () const </td></tr>

<tr class="memdesc:a8161abb1b8367aed9502d48be2d94172"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the unicast time-to-live setting on <em>socket</em>; see g_socket_set_ttl() for more details.  <a href="#a8161abb1b8367aed9502d48be2d94172">More...</a><br/></td></tr>

<tr class="separator:a8161abb1b8367aed9502d48be2d94172"><td class="memSeparator" colspan="2">&#160;</td></tr>

</div><div class="memdoc">

 

<p>Accept incoming connections on a connection-based socket. </p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

 

</div>

</div>

</div><div class="memdoc">

 

<p>When a socket is created it is attached to an address family, but it doesn't have an address in this family. </p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

 

</div>

</div>

 

<p>Checks and resets the pending connect error for the socket. </p>

<p>This is used to check for errors when g_socket_connect() is used in non-blocking mode.</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if no error, <code>false</code> otherwise, setting <em>error</em> to the error. </dd></dl>

 

</div>

<p>Once the socket is closed, all other operations will return IO_ERROR_CLOSED. Closing a socket multiple times will not return an error.</p>

<p>Sockets will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.</p>

<p>Beware that due to the way that TCP works, it is possible for recently-sent data to be lost if either you close a socket while the IO_IN condition is set, or else if the remote connection tries to send something to you after you close the socket but before it has finished reading all of the data you sent. There is no easy generic way to avoid this problem; the easiest fix is to design the network protocol such that the client will never send data "out of turn". Another solution is for the server to half-close the connection by calling g_socket_shutdown() with only the <em>shutdown_write</em> flag set, and then wait for the client to notice this and close its side of the connection, after which the server can safely call g_socket_close(). (This is what <a class="el" href="classGio_1_1TcpConnection.html" title="A TCP SocketConnection. ">TcpConnection</a> does if you call g_tcp_connection_set_graceful_disconnect(). But of course, this only works if the client will close its connection after the server does.)</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> on error. </dd></dl>

 

</div>

<p>Note that on Windows, it is possible for an operation to return IO_ERROR_WOULD_BLOCK even immediately after g_socket_condition_check() has claimed that the socket is ready for writing. Rather than calling g_socket_condition_check() and then writing to the socket if it succeeds, it is generally better to simply try writing to the socket right away, and try again later if the initial attempt returns IO_ERROR_WOULD_BLOCK.</p>

<p>It is meaningless to specify IO_ERR or IO_HUP in condition; these conditions will always be set in the output if they are true.</p>

<p>This call never blocks.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">condition</td><td>A IOCondition mask to check. </td></tr>

<p>When the condition is met, <code>true</code> is returned.</p>

<p>If <em>cancellable</em> is cancelled before the condition is met, or if the socket has a timeout set and it is reached before the condition is met, then <code>false</code> is returned and <em>error</em>, if non-<code>0</code>, is set to the appropriate value (IO_ERROR_CANCELLED or IO_ERROR_TIMED_OUT).</p>

<p>See also g_socket_condition_timed_wait().</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">condition</td><td>A IOCondition mask to wait for. </td></tr>

</div><div class="memdoc">

 

<p>Connect the socket to the specified remote address. </p>

<p>Generally connection oriented sockets can only connect once, but connection-less sockets can connect multiple times to change the default address.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

 

</div>

</div>

<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object. ">Socket</a> or <code>0</code> on error. Free the returned object with Glib::object_unref().</dd></dl>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

  </table>

  </dd>

</dl>

<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object. ">Socket</a> or <code>0</code> on error. Free the returned object with Glib::object_unref().</dd></dl>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

  </table>

  </dd>

</dl>

 

<p>Gets the blocking mode of the socket. </p>

<p>For details on blocking I/O, see g_socket_set_blocking().</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if blocking I/O is used, <code>false</code> otherwise. </dd></dl>

 

</div>

</div><div class="memdoc">

 

<p>Gets the socket family of the socket. </p>

<dl class="section return"><dt>Returns</dt><dd>A SocketFamily. </dd></dl>

 

</div>

 

<p>Returns the underlying OS socket object. </p>

<p>On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations on the socket.</p>

<dl class="section return"><dt>Returns</dt><dd>The file descriptor of the socket. </dd></dl>

 

</div>

 

<p>Gets the keepalive mode of the socket. </p>

<p>For details on this, see g_socket_set_keepalive().</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if keepalive is active, <code>false</code> otherwise. </dd></dl>

 

</div>

 

<p>Gets the listen backlog setting of the socket. </p>

<p>For details on this, see g_socket_set_listen_backlog().</p>

<dl class="section return"><dt>Returns</dt><dd>The maximum number of pending connections. </dd></dl>

 

</div>

 

<p>Try to get the local address of a bound socket. </p>

<p>This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting.</p>

<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classGio_1_1SocketAddress.html" title="Abstract base class representing endpoints for socket communication. ">SocketAddress</a> or <code>0</code> on error. Free the returned object with Glib::object_unref(). </dd></dl>

 

</div>

 

</div>

</div>

<a class="anchor" id="a4ecd966ee71eb956258b289cf63eb43e"></a>

<div class="memitem">

<div class="memproto">

 

<p>Gets the socket protocol id the socket was created with. </p>

<p>In case the protocol is unknown, -1 is returned.</p>

<dl class="section return"><dt>Returns</dt><dd>A protocol id, or -1 if unknown. </dd></dl>

 

</div>

 

<p>Try to get the remove address of a connected socket. </p>

<p>This is only useful for connection oriented sockets that have been connected.</p>

<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classGio_1_1SocketAddress.html" title="Abstract base class representing endpoints for socket communication. ">SocketAddress</a> or <code>0</code> on error. Free the returned object with Glib::object_unref(). </dd></dl>

 

</div>

</div><div class="memdoc">

 

<p>Gets the socket type of the socket. </p>

<dl class="section return"><dt>Returns</dt><dd>A SocketType. </dd></dl>

 

</div>

</div><div class="memdoc">

 

<p>Checks whether a socket is closed. </p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if socket is closed, <code>false</code> otherwise. </dd></dl>

 

</div>

 

<p>Check whether the socket is connected. </p>

<p>This is only useful for connection-oriented sockets.</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if socket is connected, <code>false</code> otherwise. </dd></dl>

 

</div>

      </table>

</div><div class="memdoc">

 

 

</div>

</div>

<p>For SOCKET_TYPE_STREAM sockets, g_socket_receive() can return any number of bytes, up to <em>size</em>. If more than <em>size</em> bytes have been received, the additional data will be returned in future calls to g_socket_receive().</p>

<p>If the socket is in blocking mode the call will block until there is some data to receive, the connection is closed, or there is an error. If there is no data available and the socket is in non-blocking mode, a IO_ERROR_WOULD_BLOCK error will be returned. To be notified when data is available, wait for the IO_IN condition.</p>

<p>On error -1 is returned and <em>error</em> is set accordingly.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">buffer</td><td>A buffer to read data into (which should be at least <em>size</em> bytes long). </td></tr>

<p>This is mainly used by connection-oriented sockets; it is identical to g_socket_send_to() with <em>address</em> set to <code>0</code>.</p>

<p>If the socket is in blocking mode the call will block until there is space for the data in the socket queue. If there is no space available and the socket is in non-blocking mode a IO_ERROR_WOULD_BLOCK error will be returned. To be notified when space is available, wait for the IO_OUT condition. Note though that you may still receive IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously notified of a IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.)</p>

<p>On error -1 is returned and <em>error</em> is set accordingly.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">buffer</td><td>The buffer containing the data to send. </td></tr>

<p>Tries to send <em>size</em> bytes from <em>buffer</em> to <em>address</em>. </p>

<p>If <em>address</em> is <code>0</code> then the message is sent to the default receiver (set by g_socket_connect()).</p>

<p>See g_socket_send() for additional information.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">address</td><td>A <a class="el" href="classGio_1_1SocketAddress.html" title="Abstract base class representing endpoints for socket communication. ">SocketAddress</a>, or <code>0</code>. </td></tr>

<p>Sets the blocking mode of the socket. </p>

<p>In blocking mode all operations block until they succeed or there is an error. In non-blocking mode all functions return results immediately or with a IO_ERROR_WOULD_BLOCK error.</p>

<p>All sockets are created in blocking mode. However, note that the platform level socket is always non-blocking, and blocking mode is a GSocket level feature.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">blocking</td><td>Whether to use blocking I/O or not. </td></tr>

<p>When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to verify the presence of the remote endpoint, it will automatically close the connection.</p>

<p>This option is only functional on certain kinds of sockets. (Notably, SOCKET_PROTOCOL_TCP sockets.)</p>

<p>The exact time between pings is system- and protocol-dependent, but will normally be at least two hours. Most commonly, you would set this flag on a server socket if you want to allow clients to remain idle for long periods of time, but also want to ensure that connections are eventually garbage-collected if clients crash or become unreachable.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">keepalive</td><td>Value for the keepalive flag. </td></tr>

<p>Sets the maximum number of outstanding connections allowed when listening on this socket. </p>

<p>If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused.</p>

<p>Note that this must be called before g_socket_listen() and has no effect if called after that.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">backlog</td><td>The maximum number of pending connections. </td></tr>

 

</div>

</div>

<a class="anchor" id="afe942e5157528b217d7af4a7839a9e7a"></a>

<div class="memitem">

<div class="memproto">

<p>If <em>shutdown_write</em> is <code>true</code> then the sending side of the connection is shut down, and further writing is disallowed.</p>

<p>It is allowed for both <em>shutdown_read</em> and <em>shutdown_write</em> to be <code>true</code>.</p>

<p>One example where this is used is graceful disconnect for TCP connections where you close the sending side, then wait for the other side to close the connection, thus ensuring that the other side saw all sent data.</p>

<dl class="params"><dt>Parameters</dt><dd>

  <table class="params">

    <tr><td class="paramname">shutdown_read</td><td>Whether to shut down the read side. </td></tr>

<p>Checks if a socket is capable of speaking IPv4. </p>

<p>IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also capable of speaking IPv4. See RFC 3493 section 3.7 for more information.</p>

<p>No other types of sockets are currently considered as being capable of speaking IPv4.</p>

<dl class="section return"><dt>Returns</dt><dd><code>true</code> if this socket can be used with IPv4. </dd></dl>

 

</div>

</div><!-- contents -->

<!-- start footer part -->

<hr class="footer"/><address class="footer"><small>

<img class="footer" src="doxygen.png" alt="doxygen"/>

</a> 1.8.4

</small></address>