1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __GIO_TYPES_H__
28 #define __GIO_TYPES_H__
30 #include <gio/gioenums.h>
34 typedef struct _GAppLaunchContext GAppLaunchContext;
35 typedef struct _GAppInfo GAppInfo; /* Dummy typedef */
36 typedef struct _GAsyncResult GAsyncResult; /* Dummy typedef */
37 typedef struct _GAsyncInitable GAsyncInitable;
38 typedef struct _GBufferedInputStream GBufferedInputStream;
39 typedef struct _GBufferedOutputStream GBufferedOutputStream;
40 typedef struct _GCancellable GCancellable;
41 typedef struct _GCharsetConverter GCharsetConverter;
42 typedef struct _GConverter GConverter;
43 typedef struct _GConverterInputStream GConverterInputStream;
44 typedef struct _GConverterOutputStream GConverterOutputStream;
45 typedef struct _GDataInputStream GDataInputStream;
46 typedef struct _GPermission GPermission;
47 typedef struct _GSimplePermission GSimplePermission;
48 typedef struct _GZlibCompressor GZlibCompressor;
49 typedef struct _GZlibDecompressor GZlibDecompressor;
54 * Opaque drive object.
56 typedef struct _GDrive GDrive; /* Dummy typedef */
57 typedef struct _GFileEnumerator GFileEnumerator;
58 typedef struct _GFileMonitor GFileMonitor;
59 typedef struct _GFilterInputStream GFilterInputStream;
60 typedef struct _GFilterOutputStream GFilterOutputStream;
65 * A handle to an object implementing the #GFileIface interface.
66 * Generally stores a location within the file system. Handles do not
67 * necessarily represent files or directories that currently exist.
69 typedef struct _GFile GFile; /* Dummy typedef */
70 typedef struct _GFileInfo GFileInfo;
73 * GFileAttributeMatcher:
75 * Determines if a string matches a file attribute.
77 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
78 typedef struct _GFileAttributeInfo GFileAttributeInfo;
79 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
80 typedef struct _GFileDescriptorBased GFileDescriptorBased;
81 typedef struct _GFileInputStream GFileInputStream;
82 typedef struct _GFileOutputStream GFileOutputStream;
83 typedef struct _GFileIOStream GFileIOStream;
84 typedef struct _GFileIcon GFileIcon;
85 typedef struct _GFilenameCompleter GFilenameCompleter;
88 typedef struct _GIcon GIcon; /* Dummy typedef */
89 typedef struct _GInetAddress GInetAddress;
90 typedef struct _GInetSocketAddress GInetSocketAddress;
91 typedef struct _GInputStream GInputStream;
92 typedef struct _GInitable GInitable;
93 typedef struct _GIOModule GIOModule;
94 typedef struct _GIOExtensionPoint GIOExtensionPoint;
95 typedef struct _GIOExtension GIOExtension;
100 * Opaque class for definining and scheduling IO jobs.
102 typedef struct _GIOSchedulerJob GIOSchedulerJob;
103 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
104 typedef struct _GMemoryInputStream GMemoryInputStream;
105 typedef struct _GMemoryOutputStream GMemoryOutputStream;
110 * A handle to an object implementing the #GMountIface interface.
112 typedef struct _GMount GMount; /* Dummy typedef */
113 typedef struct _GMountOperation GMountOperation;
114 typedef struct _GNetworkAddress GNetworkAddress;
115 typedef struct _GNetworkService GNetworkService;
116 typedef struct _GOutputStream GOutputStream;
117 typedef struct _GIOStream GIOStream;
118 typedef struct _GResolver GResolver;
119 typedef struct _GSeekable GSeekable;
120 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
125 * A lowlevel network socket object.
129 typedef struct _GSocket GSocket;
132 * GSocketControlMessage:
134 * Base class for socket-type specific control messages that can be sent and
135 * received over #GSocket.
137 typedef struct _GSocketControlMessage GSocketControlMessage;
141 * A helper class for network clients to make connections.
145 typedef struct _GSocketClient GSocketClient;
149 * A socket connection GIOStream object for connection-oriented sockets.
153 typedef struct _GSocketConnection GSocketConnection;
157 * A helper class for network servers to listen for and accept connections.
161 typedef struct _GSocketListener GSocketListener;
165 * A helper class for handling accepting incomming connections in the
170 typedef struct _GSocketService GSocketService;
171 typedef struct _GSocketAddress GSocketAddress;
172 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
173 typedef struct _GSocketConnectable GSocketConnectable;
174 typedef struct _GSrvTarget GSrvTarget;
178 * A #GSocketConnection for TCP/IP connections.
182 typedef struct _GTcpConnection GTcpConnection;
184 * GThreadedSocketService:
186 * A helper class for handling accepting incomming connections in the
187 * glib mainloop and handling them in a thread.
191 typedef struct _GThreadedSocketService GThreadedSocketService;
192 typedef struct _GThemedIcon GThemedIcon;
193 typedef struct _GVfs GVfs; /* Dummy typedef */
198 * Opaque mountable volume object.
200 typedef struct _GVolume GVolume; /* Dummy typedef */
201 typedef struct _GVolumeMonitor GVolumeMonitor;
204 * GAsyncReadyCallback:
205 * @source_object: the object the asynchronous operation was started with.
206 * @res: a #GAsyncResult.
207 * @user_data: user data passed to the callback.
209 * Type definition for a function that will be called back when an asynchronous
210 * operation within GIO has been completed.
212 typedef void (*GAsyncReadyCallback) (GObject *source_object,
217 * GFileProgressCallback:
218 * @current_num_bytes: the current number of bytes in the operation.
219 * @total_num_bytes: the total number of bytes in the operation.
220 * @user_data: user data passed to the callback.
222 * When doing file operations that may take a while, such as moving
223 * a file or copying a file, a progress callback is used to pass how
224 * far along that operation is to the application.
226 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
227 goffset total_num_bytes,
231 * GFileReadMoreCallback:
232 * @file_contents: the data as currently read.
233 * @file_size: the size of the data currently read.
234 * @callback_data: data passed to the callback.
236 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
237 * it may become necessary to determine if any more data from the file should be loaded.
238 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
239 * should be read, or %FALSE otherwise.
241 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
243 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
245 gpointer callback_data);
249 * GIOSchedulerJobFunc:
250 * @job: a #GIOSchedulerJob.
251 * @cancellable: optional #GCancellable object, %NULL to ignore.
252 * @user_data: the data to pass to callback function
256 * Note that depending on whether threads are available, the
257 * #GIOScheduler may run jobs in separate threads or in an idle
260 * Long-running jobs should periodically check the @cancellable
261 * to see if they have been cancelled.
263 * Returns: %TRUE if this function should be called again to
264 * complete the job, %FALSE if the job is complete (or cancelled)
266 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
267 GCancellable *cancellable,
271 * GSimpleAsyncThreadFunc:
272 * @res: a #GSimpleAsyncResult.
273 * @object: a #GObject.
274 * @cancellable: optional #GCancellable object, %NULL to ignore.
276 * Simple thread function that runs an asynchronous operation and
277 * checks for cancellation.
279 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
281 GCancellable *cancellable);
285 * @socket: the #GSocket
286 * @condition: the current condition at the source fired.
287 * @user_data: data passed in by the user.
289 * This is the function type of the callback used for the #GSource
290 * returned by g_socket_create_source().
292 * Returns: it should return %FALSE if the source should be removed.
296 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
297 GIOCondition condition,
302 * @buffer: Pointer to a buffer where data will be written.
303 * @size: the available size in @buffer.
305 * Structure used for scatter/gather data input.
306 * You generally pass in an array of #GInputVector<!-- -->s
307 * and the operation will store the read data starting in the
308 * first buffer, switching to the next as needed.
312 typedef struct _GInputVector GInputVector;
314 struct _GInputVector {
321 * @buffer: Pointer to a buffer of data to read.
322 * @size: the size of @buffer.
324 * Structure used for scatter/gather data output.
325 * You generally pass in an array of #GOutputVector<!-- -->s
326 * and the operation will use all the buffers as if they were
331 typedef struct _GOutputVector GOutputVector;
333 struct _GOutputVector {
334 gconstpointer buffer;
338 typedef struct _GCredentials GCredentials;
339 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;
340 typedef struct _GUnixFDList GUnixFDList;
341 typedef struct _GDBusMessage GDBusMessage;
342 typedef struct _GDBusConnection GDBusConnection;
343 typedef struct _GDBusProxy GDBusProxy;
344 typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
345 typedef struct _GDBusServer GDBusServer;
346 typedef struct _GDBusAuthObserver GDBusAuthObserver;
347 typedef struct _GDBusErrorEntry GDBusErrorEntry;
348 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
349 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable;
350 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo;
351 typedef struct _GDBusArgInfo GDBusArgInfo;
352 typedef struct _GDBusMethodInfo GDBusMethodInfo;
353 typedef struct _GDBusSignalInfo GDBusSignalInfo;
354 typedef struct _GDBusPropertyInfo GDBusPropertyInfo;
355 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
356 typedef struct _GDBusNodeInfo GDBusNodeInfo;
360 #endif /* __GIO_TYPES_H__ */