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

 <tbody>

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

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

  </td>

 </tr>

 </tbody>

<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketListener.html#a59491f0159709ed08cd71c55cb738def">add_inet_port</a> (guint16 port)</td></tr>

<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. <a href="#a59491f0159709ed08cd71c55cb738def"></a><br/></td></tr>

<tr><td class="memItemLeft" align="right" valign="top">guint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketListener.html#a7639ca25eb3efe301ba08df635c2fc37">add_any_inet_port</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGlib_1_1Object.html">Glib::Object</a> &gt;&amp; source_object)</td></tr>

<tr><td class="memItemLeft" align="right" valign="top">guint16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1SocketListener.html#a8cf1d0491124ef2eb40de9a4392e973b">add_any_inet_port</a> ()</td></tr>

<tr><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_1SocketListener.html#a5a9657d9840d3e9d85efb406bb2393d2">accept_socket</a> (<a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGlib_1_1Object.html">Glib::Object</a> &gt;&amp; source_object, 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><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks waiting for a client to connect to any of the sockets added to the listener. <a href="#a5a9657d9840d3e9d85efb406bb2393d2"></a><br/></td></tr>

<tr><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_1SocketListener.html#a3e79b5b10555b73e4359671cdb53e038">accept_socket</a> (<a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classGlib_1_1Object.html">Glib::Object</a> &gt;&amp; source_object)</td></tr>

<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classGio_1_1ThreadedSocketService.html" title="A threaded GSocketService.">ThreadedSocketService</a>, <a class="el" href="classGio_1_1SocketService.html" title="Make it easy to implement a network service.">SocketService</a>.</dd></dl>

<p>A <a class="el" href="classGio_1_1SocketListener.html" title="Helper for accepting network client connections.">SocketListener</a> is an object that keeps track of a set of server sockets and helps you accept sockets from any of the socket, either sync or async.</p>

<p>If you want to implement a network server, also look at <a class="el" href="classGio_1_1SocketService.html" title="Make it easy to implement a network service.">SocketService</a> and <a class="el" href="classGio_1_1ThreadedSocketService.html" title="A threaded GSocketService.">ThreadedSocketService</a> which are subclass of <a class="el" href="classGio_1_1SocketListener.html" title="Helper for accepting network client connections.">SocketListener</a> that makes this even easier.</p>

</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>

<a class="anchor" id="a72cc482888057f1e6747309e382ae669"></a><!-- doxytag: member="Gio::SocketListener::~SocketListener" ref="a72cc482888057f1e6747309e382ae669" args="()" -->

<div class="memitem">

<p>Returns a <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a> for the socket that was accepted.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

<p>Returns a <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a> for the socket that was accepted.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

<p>Returns a <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a> for the socket that was accepted.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

<p>Returns a <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a> for the socket that was accepted.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

 

<p>This is the asynchronous version of g_socket_listener_accept(). </p>

<p>When the operation is finished <em>callback</em> will be called. You can then call g_socket_listener_accept_socket() to get the result of the operation.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">cancellable</td><td>A <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a>, or <code>0</code>. </td></tr>

 

<p>This is the asynchronous version of g_socket_listener_accept(). </p>

<p>When the operation is finished <em>callback</em> will be called. You can then call g_socket_listener_accept_socket() to get the result of the operation.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">cancellable</td><td>A <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a>, or <code>0</code>. </td></tr>

 

<p>Finishes an async accept operation. </p>

<p>See g_socket_listener_accept_async()</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">result</td><td>A <a class="el" href="classGio_1_1AsyncResult.html" title="Provides a base class for implementing asynchronous function results.">AsyncResult</a>. </td></tr>

 

<p>Finishes an async accept operation. </p>

<p>See g_socket_listener_accept_async()</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">result</td><td>A <a class="el" href="classGio_1_1AsyncResult.html" title="Provides a base class for implementing asynchronous function results.">AsyncResult</a>. </td></tr>

<p>If you want to accept the high-level <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a>, not a <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a>, which is often the case, then you should use g_socket_listener_accept() instead.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

<p>If you want to accept the high-level <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a>, not a <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a>, which is often the case, then you should use g_socket_listener_accept() instead.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Location where Object pointer will be stored, or <code>0</code>. </td></tr>

<p>If you want to accept the high-level <a class="el" href="classGio_1_1SocketConnection.html" title="A socket connection.">SocketConnection</a>, not a <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a>, which is often the case, then you should use g_socket_listener_accept() instead.</p>

<p>If <em>source_object</em> is not <code>0</code> it will be filled out with the source object specified when the corresponding socket or address was added to the listener.</p>

<p>If <em>cancellable</em> is not <code>0</code>, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IO_ERROR_CANCELLED will be returned.</p>

<dl class="since_2_22"><dt><b><a class="el" href="since_2_22.html#_since_2_22000154">Since glibmm 2.22:</a></b></dt><dd></dd></dl>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

 

</div>

</div>

<a class="anchor" id="a8fcc271647a1aa8628d2b2e60dd53d16"></a><!-- doxytag: member="Gio::SocketListener::accept_socket_async" ref="a8fcc271647a1aa8628d2b2e60dd53d16" args="(const Glib::RefPtr&lt; Cancellable &gt; &amp;cancellable, const SlotAsyncReady &amp;slot)" -->

<div class="memitem">

<div class="memproto">

 

<p>This is the asynchronous version of g_socket_listener_accept_socket(). </p>

<p>When the operation is finished <em>callback</em> will be called. You can then call g_socket_listener_accept_socket_finish() to get the result of the operation.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">cancellable</td><td>A <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a>, or <code>0</code>. </td></tr>

 

<p>This is the asynchronous version of g_socket_listener_accept_socket(). </p>

<p>When the operation is finished <em>callback</em> will be called. You can then call g_socket_listener_accept_socket_finish() to get the result of the operation.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">cancellable</td><td>A <a class="el" href="classGio_1_1Cancellable.html" title="Allows actions to be cancelled.">Cancellable</a>, or <code>0</code>. </td></tr>

 

<p>Finishes an async accept operation. </p>

<p>See g_socket_listener_accept_socket_async()</p>

<dl class="since_2_22"><dt><b><a class="el" href="since_2_22.html#_since_2_22000159">Since glibmm 2.22:</a></b></dt><dd></dd></dl>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

 

</div>

</div>

<a class="anchor" id="a17961c5dff54d2d6e311c50d2c744bc1"></a><!-- doxytag: member="Gio::SocketListener::add_address" ref="a17961c5dff54d2d6e311c50d2c744bc1" args="(const Glib::RefPtr&lt; SocketAddress &gt; &amp;address, SocketType type, SocketProtocol protocol, Glib::RefPtr&lt; SocketAddress &gt; &amp;effective_address)" -->

<div class="memitem">

<div class="memproto">

<div class="memdoc">

 

<p>Creates a socket of type <em>type</em> and protocol <em>protocol</em>, binds it to <em>address</em> and adds it to the set of sockets we're accepting sockets from. </p>

<dl class="since_2_22"><dt><b><a class="el" href="since_2_22.html#_since_2_22000149">Since glibmm 2.22:</a></b></dt><dd></dd></dl>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

 

</div>

</div>

<a class="anchor" id="a8cf1d0491124ef2eb40de9a4392e973b"></a><!-- doxytag: member="Gio::SocketListener::add_any_inet_port" ref="a8cf1d0491124ef2eb40de9a4392e973b" args="()" -->

<div class="memitem">

<div class="memproto">

</div>

<div class="memdoc">

 

<p>This is useful if you need to have a socket for incoming connections but don't care about the specific port number.</p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Optional Object identifying this source. </td></tr>

</div>

<div class="memdoc">

 

<p>This is useful if you need to have a socket for incoming connections but don't care about the specific port number.</p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">source_object</td><td>Optional Object identifying this source. </td></tr>

 

<p>Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. </p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">port</td><td>An IP port number (non-zero). </td></tr>

 

<p>Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. </p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">port</td><td>An IP port number (non-zero). </td></tr>

<p>Adds <em>socket</em> to the set of sockets that we try to accept new clients from. </p>

<p>The socket must be bound to a local address and listened to.</p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">socket</td><td>A listening <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a>. </td></tr>

<p>Adds <em>socket</em> to the set of sockets that we try to accept new clients from. </p>

<p>The socket must be bound to a local address and listened to.</p>

<p><em>source_object</em> will be passed out in the various calls to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to.</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">socket</td><td>A listening <a class="el" href="classGio_1_1Socket.html" title="Low-level socket object.">Socket</a>. </td></tr>

<div class="memdoc">

 

<p>Closes all the sockets in the listener. </p>

 

</div>

</div>

 

<p>Sets the listen backlog on the sockets in the listener. </p>

<p>See g_socket_set_listen_backlog() for details</p>

<dl><dt><b>Parameters:</b></dt><dd>

  <table class="params">

    <tr><td class="paramname">listen_backlog</td><td>An integer. </td></tr>

</div>

</div>

</div>

<a href="http://www.doxygen.org/index.html">

<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>

</body>