gio: deprecate gioscheduler, soft deprecate GSimpleAsyncResult
[platform/upstream/glib.git] / docs / reference / gio / gio-docs.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
3                       'http://www.oasis-open.org/docbook/xml/4.5/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="utils">
36         <title>File-related Utilities</title>
37         <xi:include href="xml/gfilenamecompleter.xml"/>
38     </chapter>
39     <chapter id="async">
40         <title>Asynchronous I/O</title>
41         <xi:include href="xml/gcancellable.xml"/>
42         <xi:include href="xml/gasyncresult.xml"/>
43         <xi:include href="xml/gtask.xml"/>
44         <xi:include href="xml/gioscheduler.xml"/>
45         <xi:include href="xml/gsimpleasyncresult.xml"/>
46     </chapter>
47     <chapter id="conversion">
48         <title>Data conversion</title>
49         <xi:include href="xml/gconverter.xml"/>
50         <xi:include href="xml/gcharsetconverter.xml"/>
51         <xi:include href="xml/gzcompressor.xml"/>
52         <xi:include href="xml/gzdecompressor.xml"/>
53     </chapter>
54     <chapter id="streaming">
55         <title>Streaming I/O</title>
56         <xi:include href="xml/gseekable.xml"/>
57         <xi:include href="xml/ginputstream.xml"/>
58         <xi:include href="xml/goutputstream.xml"/>
59         <xi:include href="xml/giostream.xml"/>
60         <xi:include href="xml/gfileinputstream.xml"/>
61         <xi:include href="xml/gfileoutputstream.xml"/>
62         <xi:include href="xml/gfileiostream.xml"/>
63         <xi:include href="xml/gfiledescriptorbased.xml"/>
64         <xi:include href="xml/gfilterinputstream.xml"/>
65         <xi:include href="xml/gfilteroutputstream.xml"/>
66         <xi:include href="xml/gmemoryinputstream.xml"/>
67         <xi:include href="xml/gmemoryoutputstream.xml"/>
68         <xi:include href="xml/gbufferedinputstream.xml"/>
69         <xi:include href="xml/gbufferedoutputstream.xml"/>
70         <xi:include href="xml/gdatainputstream.xml"/>
71         <xi:include href="xml/gdataoutputstream.xml"/>
72         <xi:include href="xml/gunixinputstream.xml"/>
73         <xi:include href="xml/gunixoutputstream.xml"/>
74         <xi:include href="xml/gwin32inputstream.xml"/>
75         <xi:include href="xml/gwin32outputstream.xml"/>
76         <xi:include href="xml/gconverterinputstream.xml"/>
77         <xi:include href="xml/gconverteroutputstream.xml"/>
78         <xi:include href="xml/gpollableinputstream.xml"/>
79         <xi:include href="xml/gpollableoutputstream.xml"/>
80         <xi:include href="xml/gpollableutils.xml"/>
81     </chapter>
82     <chapter id="types">
83         <title>File types and applications</title>
84         <xi:include href="xml/gcontenttype.xml"/>
85         <xi:include href="xml/gappinfo.xml"/>
86         <xi:include href="xml/gdesktopappinfo.xml"/>
87     </chapter>
88     <chapter id="volume_mon">
89         <title>Volumes and Drives</title>
90         <xi:include href="xml/gvolumemonitor.xml"/>
91         <xi:include href="xml/gvolume.xml"/>
92         <xi:include href="xml/gmount.xml"/>
93         <xi:include href="xml/gdrive.xml"/>
94         <xi:include href="xml/gunixmounts.xml"/>
95     </chapter>
96     <chapter id="icons">
97         <title>Icons</title>
98         <xi:include href="xml/gicon.xml"/>
99         <xi:include href="xml/gfileicon.xml"/>
100         <xi:include href="xml/gloadableicon.xml"/>
101         <xi:include href="xml/gthemedicon.xml"/>
102         <xi:include href="xml/gemblemedicon.xml"/>
103         <xi:include href="xml/gemblem.xml"/>
104     </chapter>
105     <chapter id="failable_initialization">
106         <title>Failable Initialization</title>
107         <xi:include href="xml/ginitable.xml"/>
108         <xi:include href="xml/gasyncinitable.xml"/>
109     </chapter>
110     <chapter id="networking">
111       <title>Low-level network support</title>
112       <xi:include href="xml/gsocket.xml"/>
113       <xi:include href="xml/ginetaddress.xml"/>
114       <xi:include href="xml/ginetaddressmask.xml"/>
115       <xi:include href="xml/gsocketaddress.xml"/>
116       <xi:include href="xml/ginetsocketaddress.xml"/>
117       <xi:include href="xml/gunixsocketaddress.xml"/>
118       <xi:include href="xml/gsocketcontrolmessage.xml"/>
119       <xi:include href="xml/gunixfdlist.xml"/>
120       <xi:include href="xml/gunixfdmessage.xml"/>
121       <xi:include href="xml/gcredentials.xml"/>
122       <xi:include href="xml/gunixcredentialsmessage.xml"/>
123       <xi:include href="xml/gproxy.xml"/>
124       <xi:include href="xml/gproxyaddress.xml"/>
125     </chapter>
126     <chapter id="highlevel-socket">
127       <title>High-level network functionallity</title>
128       <xi:include href="xml/gsocketclient.xml"/>
129       <xi:include href="xml/gsocketconnection.xml"/>
130       <xi:include href="xml/gunixconnection.xml"/>
131       <xi:include href="xml/gtcpconnection.xml"/>
132       <xi:include href="xml/gtcpwrapperconnection.xml"/>
133       <xi:include href="xml/gsocketlistener.xml"/>
134       <xi:include href="xml/gsocketservice.xml"/>
135       <xi:include href="xml/gthreadedsocketservice.xml"/>
136       <xi:include href="xml/gnetworkmonitor.xml"/>
137     </chapter>
138     <chapter id="tls">
139       <title>TLS (SSL) support</title>
140       <xi:include href="xml/gtls.xml"/>
141       <xi:include href="xml/gtlscertificate.xml"/>
142       <xi:include href="xml/gtlsconnection.xml"/>
143       <xi:include href="xml/gtlsclientconnection.xml"/>
144       <xi:include href="xml/gtlsserverconnection.xml"/>
145       <xi:include href="xml/gtlsbackend.xml"/>
146       <xi:include href="xml/gtlsdatabase.xml"/>
147       <xi:include href="xml/gtlsfiledatabase.xml"/>
148       <xi:include href="xml/gtlsinteraction.xml"/>
149       <xi:include href="xml/gtlspassword.xml"/>
150     </chapter>
151     <chapter id="resolver">
152       <title>DNS resolution</title>
153       <xi:include href="xml/gresolver.xml"/>
154       <xi:include href="xml/gproxyresolver.xml"/>
155       <xi:include href="xml/gsocketconnectable.xml"/>
156       <xi:include href="xml/gnetworkaddress.xml"/>
157       <xi:include href="xml/gnetworkservice.xml"/>
158       <xi:include href="xml/gsrvtarget.xml"/>
159     </chapter>
160     <chapter id="gdbus-lowlevel">
161       <title>Lowlevel D-Bus Support</title>
162       <xi:include href="xml/gdbusutils.xml"/>
163       <xi:include href="xml/gdbusaddress.xml"/>
164       <xi:include href="xml/gdbusintrospection.xml"/>
165       <xi:include href="xml/gdbuserror.xml"/>
166       <xi:include href="xml/gdbusmessage.xml"/>
167       <xi:include href="xml/gdbusconnection.xml"/>
168       <xi:include href="xml/gdbusmethodinvocation.xml"/>
169       <xi:include href="xml/gdbusserver.xml"/>
170       <xi:include href="xml/gdbusauthobserver.xml"/>
171     </chapter>
172     <chapter id="gdbus-convenience">
173       <title>Highlevel D-Bus Support</title>
174       <xi:include href="xml/gdbusnameowning.xml"/>
175       <xi:include href="xml/gdbusnamewatching.xml"/>
176       <xi:include href="xml/gdbusinterface.xml"/>
177       <xi:include href="xml/gdbusinterfaceskeleton.xml"/>
178       <xi:include href="xml/gdbusproxy.xml"/>
179       <xi:include href="xml/gdbusobject.xml"/>
180       <xi:include href="xml/gdbusobjectskeleton.xml"/>
181       <xi:include href="xml/gdbusobjectproxy.xml"/>
182       <xi:include href="xml/gdbusobjectmanager.xml"/>
183       <xi:include href="xml/gdbusobjectmanagerserver.xml"/>
184       <xi:include href="xml/gdbusobjectmanagerclient.xml"/>
185     </chapter>
186     <chapter id="settings">
187         <title>Settings</title>
188         <xi:include href="xml/gsettings.xml"/>
189         <xi:include href="xml/gsettingsbackend.xml"/>
190         <xi:include href="xml/gsettingsschema.xml"/>
191     </chapter>
192     <chapter id="resources">
193         <title>Resources</title>
194         <xi:include href="xml/gresource.xml"/>
195     </chapter>
196     <chapter id='permissions'>
197         <title>Permissions</title>
198         <xi:include href="xml/gpermission.xml"/>
199         <xi:include href="xml/gsimplepermission.xml"/>
200     </chapter>
201     <chapter id="application">
202         <title>Application support</title>
203         <xi:include href="xml/gapplication.xml"/>
204         <xi:include href="xml/gapplicationcommandline.xml"/>
205         <xi:include href="xml/gactiongroup.xml"/>
206         <xi:include href="xml/gactionmap.xml"/>
207         <xi:include href="xml/gsimpleactiongroup.xml"/>
208         <xi:include href="xml/gaction.xml"/>
209         <xi:include href="xml/gsimpleaction.xml"/>
210         <xi:include href="xml/gremoteactiongroup.xml"/>
211         <xi:include href="xml/gactiongroupexporter.xml"/>
212         <xi:include href="xml/gdbusactiongroup.xml"/>
213         <xi:include href="xml/gmenumodel.xml"/>
214         <xi:include href="xml/gmenu.xml"/>
215         <xi:include href="xml/gmenuexporter.xml"/>
216         <xi:include href="xml/gdbusmenumodel.xml"/>
217     </chapter>
218     <chapter id="extending">
219         <title>Extending GIO</title>
220         <xi:include href="xml/gvfs.xml"/>
221         <xi:include href="xml/giomodule.xml"/>
222         <xi:include href="xml/extensionpoints.xml"/>
223     </chapter>
224     <chapter id="tools">
225         <title>GIO Tools</title>
226         <xi:include href="gio-querymodules.xml"/>
227         <xi:include href="gsettings.xml"/>
228         <xi:include href="glib-compile-schemas.xml"/>
229         <xi:include href="glib-compile-resources.xml"/>
230         <xi:include href="gdbus.xml"/>
231         <xi:include href="xml/gdbus-codegen.xml"/>
232         <xi:include href="gresource.xml"/>
233     </chapter>
234     <chapter id="testing">
235         <title>GIO Testing</title>
236         <xi:include href="xml/gtestdbus.xml"/>
237     </chapter>
238   </part>
239
240   <part id="migrating">
241     <title>Migrating to GIO</title>
242     <xi:include href="xml/migrating-posix.xml"/>
243     <xi:include href="xml/migrating-gnome-vfs.xml"/>
244     <xi:include href="xml/migrating-gconf.xml"/>
245     <xi:include href="xml/migrating-gdbus.xml"/>
246   </part>
247
248   <chapter id="gio-hierarchy">
249     <title>Object Hierarchy</title>
250       <xi:include href="xml/tree_index.sgml"/>
251   </chapter>
252   
253   <index id="api-index-full">
254     <title id="index-all">Index</title>
255     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
256   </index>
257   <index id="api-index-deprecated" role="deprecated">
258     <title>Index of deprecated symbols</title>
259     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
260   </index>
261   <index id="api-index-2-18" role="2.18">
262     <title>Index of new symbols in 2.18</title>
263     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
264   </index>
265   <index id="api-index-2-20" role="2.20">
266     <title>Index of new symbols in 2.20</title>
267     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
268   </index>
269   <index id="api-index-2-22" role="2.22">
270     <title>Index of new symbols in 2.22</title>
271     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
272   </index>
273   <index id="api-index-2-24" role="2.24">
274     <title>Index of new symbols in 2.24</title>
275     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
276   </index>
277   <index id="api-index-2-26" role="2.26">
278     <title>Index of new symbols in 2.26</title>
279     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
280   </index>
281   <index id="api-index-2-28" role="2.28">
282     <title>Index of new symbols in 2.28</title>
283     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
284   </index>
285   <index id="api-index-2-30" role="2.30">
286     <title>Index of new symbols in 2.30</title>
287     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
288   </index>
289   <index id="api-index-2-32" role="2.32">
290     <title>Index of new symbols in 2.32</title>
291     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
292   </index>
293   <index id="api-index-2-34" role="2.34">
294     <title>Index of new symbols in 2.34</title>
295     <xi:include href="xml/api-index-2.34.xml"><xi:fallback /></xi:include>
296   </index>
297
298   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
299
300 </book>