summaryrefslogtreecommitdiff
path: root/gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html
diff options
context:
space:
mode:
authorLeo Tenenbaum <pommicket@gmail.com>2018-08-20 21:12:06 -0400
committerLeo Tenenbaum <pommicket@gmail.com>2018-08-20 21:12:06 -0400
commit63e87c2d0c9d263f14c77b68f85c67d46ece82a9 (patch)
tree6260365cbf7d24f37d27669e8538227fcb72e243 /gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html
parenta4460f6d9453bbd7e584937686449cef3e19f052 (diff)
Removed gtk+ docsHEADmaster
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html')
-rw-r--r--gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html260
1 files changed, 0 insertions, 260 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html b/gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html
deleted file mode 100644
index b415389..0000000
--- a/gtk+-mingw/share/gtk-doc/html/gio/GSocketService.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GSocketService</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
-<link rel="home" href="index.html" title="GIO Reference Manual">
-<link rel="up" href="highlevel-socket.html" title="High-level network functionallity">
-<link rel="prev" href="GSocketListener.html" title="GSocketListener">
-<link rel="next" href="GThreadedSocketService.html" title="GThreadedSocketService">
-<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
-<link rel="stylesheet" href="style.css" type="text/css">
-</head>
-<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
-<tr valign="middle">
-<td><a accesskey="p" href="GSocketListener.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
-<td><a accesskey="u" href="highlevel-socket.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
-<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
-<th width="100%" align="center">GIO Reference Manual</th>
-<td><a accesskey="n" href="GThreadedSocketService.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
-</tr>
-<tr><td colspan="5" class="shortcuts">
-<a href="#GSocketService.synopsis" class="shortcut">Top</a>
-  | 
- <a href="#GSocketService.description" class="shortcut">Description</a>
-  | 
- <a href="#GSocketService.object-hierarchy" class="shortcut">Object Hierarchy</a>
-  | 
- <a href="#GSocketService.signals" class="shortcut">Signals</a>
-</td></tr>
-</table>
-<div class="refentry">
-<a name="GSocketService"></a><div class="titlepage"></div>
-<div class="refnamediv"><table width="100%"><tr>
-<td valign="top">
-<h2><span class="refentrytitle"><a name="GSocketService.top_of_page"></a>GSocketService</span></h2>
-<p>GSocketService — Make it easy to implement a network service</p>
-</td>
-<td valign="top" align="right"></td>
-</tr></table></div>
-<div class="refsynopsisdiv">
-<a name="GSocketService.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis"> <a class="link" href="GSocketService.html#GSocketService-struct" title="GSocketService">GSocketService</a>;
-<a class="link" href="GSocketService.html" title="GSocketService"><span class="returnvalue">GSocketService</span></a> * <a class="link" href="GSocketService.html#g-socket-service-new" title="g_socket_service_new ()">g_socket_service_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
-<span class="returnvalue">void</span> <a class="link" href="GSocketService.html#g-socket-service-start" title="g_socket_service_start ()">g_socket_service_start</a> (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);
-<span class="returnvalue">void</span> <a class="link" href="GSocketService.html#g-socket-service-stop" title="g_socket_service_stop ()">g_socket_service_stop</a> (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);
-<a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GSocketService.html#g-socket-service-is-active" title="g_socket_service_is_active ()">g_socket_service_is_active</a> (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);
-</pre>
-</div>
-<div class="refsect1">
-<a name="GSocketService.object-hierarchy"></a><h2>Object Hierarchy</h2>
-<pre class="synopsis">
- <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
- +----<a class="link" href="GSocketListener.html" title="GSocketListener">GSocketListener</a>
- +----GSocketService
- +----<a class="link" href="GThreadedSocketService.html" title="GThreadedSocketService">GThreadedSocketService</a>
-</pre>
-</div>
-<div class="refsect1">
-<a name="GSocketService.signals"></a><h2>Signals</h2>
-<pre class="synopsis">
- "<a class="link" href="GSocketService.html#GSocketService-incoming" title='The "incoming" signal'>incoming</a>" : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
-</pre>
-</div>
-<div class="refsect1">
-<a name="GSocketService.description"></a><h2>Description</h2>
-<p>
-A <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> is an object that represents a service that
-is provided to the network or over local sockets. When a new
-connection is made to the service the <a class="link" href="GSocketService.html#GSocketService-incoming" title='The "incoming" signal'><span class="type">"incoming"</span></a>
-signal is emitted.
-</p>
-<p>
-A <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> is a subclass of <a class="link" href="GSocketListener.html" title="GSocketListener"><span class="type">GSocketListener</span></a> and you need
-to add the addresses you want to accept connections on with the
-<a class="link" href="GSocketListener.html" title="GSocketListener"><span class="type">GSocketListener</span></a> APIs.
-</p>
-<p>
-There are two options for implementing a network service based on
-<a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>. The first is to create the service using
-<a class="link" href="GSocketService.html#g-socket-service-new" title="g_socket_service_new ()"><code class="function">g_socket_service_new()</code></a> and to connect to the <a class="link" href="GSocketService.html#GSocketService-incoming" title='The "incoming" signal'><span class="type">"incoming"</span></a>
-signal. The second is to subclass <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> and override the
-default signal handler implementation.
-</p>
-<p>
-In either case, the handler must immediately return, or else it
-will block additional incoming connections from being serviced.
-If you are interested in writing connection handlers that contain
-blocking code then see <a class="link" href="GThreadedSocketService.html" title="GThreadedSocketService"><span class="type">GThreadedSocketService</span></a>.
-</p>
-<p>
-The socket service runs on the main loop of the <GTKDOCLINK HREF="g-main-context-push-thread-default-context">thread-default
-context</GTKDOCLINK> of the thread it is created in, and is not
-threadsafe in general. However, the calls to start and stop the
-service are thread-safe so these can be used from threads that
-handle incoming clients.
-</p>
-</div>
-<div class="refsect1">
-<a name="GSocketService.details"></a><h2>Details</h2>
-<div class="refsect2">
-<a name="GSocketService-struct"></a><h3>GSocketService</h3>
-<pre class="programlisting">typedef struct _GSocketService GSocketService;</pre>
-<p>
-A helper class for handling accepting incomming connections in the
-glib mainloop.
-</p>
-<p class="since">Since 2.22</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="g-socket-service-new"></a><h3>g_socket_service_new ()</h3>
-<pre class="programlisting"><a class="link" href="GSocketService.html" title="GSocketService"><span class="returnvalue">GSocketService</span></a> * g_socket_service_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
-<p>
-Creates a new <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> with no sockets to listen for.
-New listeners can be added with e.g. <a class="link" href="GSocketListener.html#g-socket-listener-add-address" title="g_socket_listener_add_address ()"><code class="function">g_socket_listener_add_address()</code></a>
-or <a class="link" href="GSocketListener.html#g-socket-listener-add-inet-port" title="g_socket_listener_add_inet_port ()"><code class="function">g_socket_listener_add_inet_port()</code></a>.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody><tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>a new <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>.</td>
-</tr></tbody>
-</table></div>
-<p class="since">Since 2.22</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="g-socket-service-start"></a><h3>g_socket_service_start ()</h3>
-<pre class="programlisting"><span class="returnvalue">void</span> g_socket_service_start (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);</pre>
-<p>
-Starts the service, i.e. start accepting connections
-from the added sockets when the mainloop runs.
-</p>
-<p>
-This call is thread-safe, so it may be called from a thread
-handling an incoming client request.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody><tr>
-<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
-<td>a <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>
-</td>
-</tr></tbody>
-</table></div>
-<p class="since">Since 2.22</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="g-socket-service-stop"></a><h3>g_socket_service_stop ()</h3>
-<pre class="programlisting"><span class="returnvalue">void</span> g_socket_service_stop (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);</pre>
-<p>
-Stops the service, i.e. stops accepting connections
-from the added sockets when the mainloop runs.
-</p>
-<p>
-This call is thread-safe, so it may be called from a thread
-handling an incoming client request.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody><tr>
-<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
-<td>a <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>
-</td>
-</tr></tbody>
-</table></div>
-<p class="since">Since 2.22</p>
-</div>
-<hr>
-<div class="refsect2">
-<a name="g-socket-service-is-active"></a><h3>g_socket_service_is_active ()</h3>
-<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> g_socket_service_is_active (<em class="parameter"><code><a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service</code></em>);</pre>
-<p>
-Check whether the service is active or not. An active
-service will accept new clients that connect, while
-a non-active service will let connecting clients queue
-up until the service is started.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
-<td>a <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>
-</td>
-</tr>
-<tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>
-<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the service is active, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
-</tr>
-</tbody>
-</table></div>
-<p class="since">Since 2.22</p>
-</div>
-</div>
-<div class="refsect1">
-<a name="GSocketService.signal-details"></a><h2>Signal Details</h2>
-<div class="refsect2">
-<a name="GSocketService-incoming"></a><h3>The <code class="literal">"incoming"</code> signal</h3>
-<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> user_function (<a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a> *service,
- <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> *connection,
- <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *source_object,
- <a href="./../glib/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
-<p>
-The ::incoming signal is emitted when a new incoming connection
-to <em class="parameter"><code>service</code></em> needs to be handled. The handler must initiate the
-handling of <em class="parameter"><code>connection</code></em>, but may not block; in essence,
-asynchronous operations must be used.
-</p>
-<p>
-<em class="parameter"><code>connection</code></em> will be unreffed once the signal handler returns,
-so you need to ref it yourself if you are planning to use it.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
-<td>the <a class="link" href="GSocketService.html" title="GSocketService"><span class="type">GSocketService</span></a>
-</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
-<td>a new <a class="link" href="GSocketConnection.html" title="GSocketConnection"><span class="type">GSocketConnection</span></a> object</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>source_object</code></em> :</span></p></td>
-<td>the source_object passed to
-<a class="link" href="GSocketListener.html#g-socket-listener-add-address" title="g_socket_listener_add_address ()"><code class="function">g_socket_listener_add_address()</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
-</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
-<td>user data set when the signal handler was connected.</td>
-</tr>
-<tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>
-<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being called</td>
-</tr>
-</tbody>
-</table></div>
-<p class="since">Since 2.22</p>
-</div>
-</div>
-<div class="refsect1">
-<a name="GSocketService.see-also"></a><h2>See Also</h2>
-<a class="link" href="GThreadedSocketService.html" title="GThreadedSocketService"><span class="type">GThreadedSocketService</span></a>, <a class="link" href="GSocketListener.html" title="GSocketListener"><span class="type">GSocketListener</span></a>.
-</div>
-</div>
-<div class="footer">
-<hr>
- Generated by GTK-Doc V1.18</div>
-</body>
-</html> \ No newline at end of file