Add pollable input/output streams
[platform/upstream/glib.git] / docs / reference / gio / gio-docs.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5 <!ENTITY version SYSTEM "version.xml">
6 ]>
7 <book lang="en" id="gio" xmlns:xi="http://www.w3.org/2003/XInclude">
8 <title>GIO Reference Manual</title>
9   <bookinfo>
10     <title>GIO Reference Manual</title>
11     <releaseinfo>
12       for GIO &version;
13       The latest version of this documentation can be found on-line at
14       <ulink role="online-location" url="http://library.gnome.org/devel/gio/unstable/">http://library.gnome.org/devel/gio/unstable/</ulink>.
15     </releaseinfo>
16   </bookinfo>
17
18   <xi:include href="xml/overview.xml"/>
19
20   <part>
21   <title>API Reference</title>
22     <chapter id="file_ops">
23         <title>File Operations</title>
24         <xi:include href="xml/gfile.xml"/>
25         <xi:include href="xml/gfileattribute.xml"/>
26         <xi:include href="xml/gfileinfo.xml"/>
27         <xi:include href="xml/gfileenumerator.xml"/>
28         <xi:include href="xml/gioerror.xml"/>
29         <xi:include href="xml/gmountoperation.xml"/>
30     </chapter>
31     <chapter id="file_mon">
32         <title>File System Monitoring</title>
33         <xi:include href="xml/gfilemonitor.xml"/>
34     </chapter>
35     <chapter id="async">
36         <title>Asynchronous I/O</title>
37         <xi:include href="xml/gcancellable.xml"/>
38         <xi:include href="xml/gasyncresult.xml"/>
39         <xi:include href="xml/gioscheduler.xml"/>
40         <xi:include href="xml/gsimpleasyncresult.xml"/>
41     </chapter>
42     <chapter id="conversion">
43         <title>Data conversion</title>
44         <xi:include href="xml/gconverter.xml"/>
45         <xi:include href="xml/gcharsetconverter.xml"/>
46         <xi:include href="xml/gzcompressor.xml"/>
47         <xi:include href="xml/gzdecompressor.xml"/>
48     </chapter>
49     <chapter id="streaming">
50         <title>Streaming I/O</title>
51         <xi:include href="xml/gseekable.xml"/>
52         <xi:include href="xml/ginputstream.xml"/>
53         <xi:include href="xml/goutputstream.xml"/>
54         <xi:include href="xml/giostream.xml"/>
55         <xi:include href="xml/gfileinputstream.xml"/>
56         <xi:include href="xml/gfileoutputstream.xml"/>
57         <xi:include href="xml/gfileiostream.xml"/>
58         <xi:include href="xml/gfiledescriptorbased.xml"/>
59         <xi:include href="xml/gfilterinputstream.xml"/>
60         <xi:include href="xml/gfilteroutputstream.xml"/>
61         <xi:include href="xml/gmemoryinputstream.xml"/>
62         <xi:include href="xml/gmemoryoutputstream.xml"/>
63         <xi:include href="xml/gbufferedinputstream.xml"/>
64         <xi:include href="xml/gbufferedoutputstream.xml"/>
65         <xi:include href="xml/gdatainputstream.xml"/>
66         <xi:include href="xml/gdataoutputstream.xml"/>
67         <xi:include href="xml/gunixinputstream.xml"/>
68         <xi:include href="xml/gunixoutputstream.xml"/>
69         <xi:include href="xml/gconverterinputstream.xml"/>
70         <xi:include href="xml/gconverteroutputstream.xml"/>
71         <xi:include href="xml/gpollableinputstream.xml"/>
72         <xi:include href="xml/gpollableoutputstream.xml"/>
73     </chapter>
74     <chapter id="types">
75         <title>File types and applications</title>
76         <xi:include href="xml/gcontenttype.xml"/>
77         <xi:include href="xml/gappinfo.xml"/>
78         <xi:include href="xml/gdesktopappinfo.xml"/>
79     </chapter>
80     <chapter id="volume_mon">
81         <title>Volumes and Drives</title>
82         <xi:include href="xml/gvolumemonitor.xml"/>
83         <xi:include href="xml/gvolume.xml"/>
84         <xi:include href="xml/gmount.xml"/>
85         <xi:include href="xml/gdrive.xml"/>
86         <xi:include href="xml/gunixmounts.xml"/>
87     </chapter>
88     <chapter id="icons">
89         <title>Icons</title>
90         <xi:include href="xml/gicon.xml"/>
91         <xi:include href="xml/gfileicon.xml"/>
92         <xi:include href="xml/gloadableicon.xml"/>
93         <xi:include href="xml/gthemedicon.xml"/>
94         <xi:include href="xml/gemblemedicon.xml"/>
95         <xi:include href="xml/gemblem.xml"/>
96     </chapter>
97     <chapter id="failable_initialization">
98         <title>Failable Initialization</title>
99         <xi:include href="xml/ginitable.xml"/>
100         <xi:include href="xml/gasyncinitable.xml"/>
101     </chapter>
102     <chapter id="networking">
103       <title>Lowlevel network support</title>
104       <xi:include href="xml/gsocket.xml"/>
105       <xi:include href="xml/ginetaddress.xml"/>
106       <xi:include href="xml/gsocketaddress.xml"/>
107       <xi:include href="xml/ginetsocketaddress.xml"/>
108       <xi:include href="xml/gunixsocketaddress.xml"/>
109       <xi:include href="xml/gsocketcontrolmessage.xml"/>
110       <xi:include href="xml/gunixfdlist.xml"/>
111       <xi:include href="xml/gunixfdmessage.xml"/>
112       <xi:include href="xml/gcredentials.xml"/>
113       <xi:include href="xml/gunixcredentialsmessage.xml"/>
114       <xi:include href="xml/gproxy.xml"/>
115       <xi:include href="xml/gproxyaddress.xml"/>
116     </chapter>
117     <chapter id="highlevel-socket">
118       <title>Highlevel network functionallity</title>
119       <xi:include href="xml/gsocketclient.xml"/>
120       <xi:include href="xml/gsocketconnection.xml"/>
121       <xi:include href="xml/gunixconnection.xml"/>
122       <xi:include href="xml/gtcpconnection.xml"/>
123       <xi:include href="xml/gsocketlistener.xml"/>
124       <xi:include href="xml/gsocketservice.xml"/>
125       <xi:include href="xml/gthreadedsocketservice.xml"/>
126     </chapter>
127     <chapter id="resolver">
128       <title>DNS resolution</title>
129       <xi:include href="xml/gresolver.xml"/>
130       <xi:include href="xml/gproxyresolver.xml"/>
131       <xi:include href="xml/gsocketconnectable.xml"/>
132       <xi:include href="xml/gnetworkaddress.xml"/>
133       <xi:include href="xml/gnetworkservice.xml"/>
134       <xi:include href="xml/gsrvtarget.xml"/>
135     </chapter>
136     <chapter id="gdbus-lowlevel">
137       <title>Lowlevel D-Bus Support</title>
138       <xi:include href="xml/gdbusutils.xml"/>
139       <xi:include href="xml/gdbusaddress.xml"/>
140       <xi:include href="xml/gdbusintrospection.xml"/>
141       <xi:include href="xml/gdbuserror.xml"/>
142       <xi:include href="xml/gdbusmessage.xml"/>
143       <xi:include href="xml/gdbusconnection.xml"/>
144       <xi:include href="xml/gdbusmethodinvocation.xml"/>
145       <xi:include href="xml/gdbusserver.xml"/>
146       <xi:include href="xml/gdbusauthobserver.xml"/>
147     </chapter>
148     <chapter id="gdbus-convenience">
149       <title>Highlevel D-Bus Support</title>
150       <xi:include href="xml/gdbusnameowning.xml"/>
151       <xi:include href="xml/gdbusnamewatching.xml"/>
152       <xi:include href="xml/gdbusproxy.xml"/>
153     </chapter>
154     <chapter id="utils">
155         <title>Utilities</title>
156         <xi:include href="xml/gfilenamecompleter.xml"/>
157     </chapter>
158     <chapter id="settings">
159         <title>Settings</title>
160         <xi:include href="xml/gsettings.xml"/>
161         <xi:include href="xml/gsettingsbackend.xml"/>
162     </chapter>
163     <chapter id='permissions'>
164         <title>Permissions</title>
165         <xi:include href="xml/gpermission.xml"/>
166         <xi:include href="xml/gsimplepermission.xml"/>
167     </chapter>
168     <chapter id="application">
169         <title>Application support</title>
170         <xi:include href="xml/gactiongroup.xml"/>
171         <xi:include href="xml/gsimpleactiongroup.xml"/>
172         <xi:include href="xml/gaction.xml"/>
173         <xi:include href="xml/gsimpleaction.xml"/>
174         <xi:include href="xml/gapplication.xml"/>
175         <xi:include href="xml/gapplicationcommandline.xml"/>
176     </chapter>
177     <chapter id="periodic">
178         <title>Periodic Timer</title>
179         <xi:include href="xml/gperiodic.xml"/>
180     </chapter>
181     <chapter id="extending">
182         <title>Extending GIO</title>
183         <xi:include href="xml/gvfs.xml"/>
184         <xi:include href="xml/giomodule.xml"/>
185         <xi:include href="xml/extensionpoints.xml"/>
186     </chapter>
187     <chapter id="tools">
188         <title>GIO Tools</title>
189         <xi:include href="gio-querymodules.xml"/>
190         <xi:include href="gsettings.xml"/>
191         <xi:include href="glib-compile-schemas.xml"/>
192         <xi:include href="gdbus.xml"/>
193     </chapter>
194   </part>
195
196   <part id="migrating">
197     <title>Migrating to GIO</title>
198     <xi:include href="xml/migrating-posix.xml"/>
199     <xi:include href="xml/migrating-gnome-vfs.xml"/>
200     <xi:include href="xml/migrating-gconf.xml"/>
201     <xi:include href="xml/migrating-gdbus.xml"/>
202   </part>
203
204   <chapter id="gio-hierarchy">
205     <title>Object Hierarchy</title>
206       <xi:include href="xml/tree_index.sgml"/>
207   </chapter>
208   
209   <index id="api-index-full">
210     <title id="index-all">Index</title>
211     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
212   </index>
213   <index id="api-index-deprecated" role="deprecated">
214     <title>Index of deprecated symbols</title>
215     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
216   </index>
217   <index id="api-index-2-18" role="2.18">
218     <title>Index of new symbols in 2.18</title>
219     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
220   </index>
221   <index id="api-index-2-20" role="2.20">
222     <title>Index of new symbols in 2.20</title>
223     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
224   </index>
225   <index id="api-index-2-22" role="2.22">
226     <title>Index of new symbols in 2.22</title>
227     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
228   </index>
229   <index id="api-index-2-24" role="2.24">
230     <title>Index of new symbols in 2.24</title>
231     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
232   </index>
233   <index id="api-index-2-26" role="2.26">
234     <title>Index of new symbols in 2.26</title>
235     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
236   </index>
237   <index id="api-index-2-28" role="2.28">
238     <title>Index of new symbols in 2.28</title>
239     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
240   </index>
241
242   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
243
244 </book>