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 _GSimplePermission GSimplePermission;
47 typedef struct _GZlibCompressor GZlibCompressor;
48 typedef struct _GZlibDecompressor GZlibDecompressor;
50 typedef struct _GSimpleActionGroup GSimpleActionGroup;
51 typedef struct _GActionGroup GActionGroup;
52 typedef struct _GAction GAction;
53 typedef struct _GSettingsBackend GSettingsBackend;
54 typedef struct _GSettings GSettings;
55 typedef struct _GPermission GPermission;
60 * Opaque drive object.
62 typedef struct _GDrive GDrive; /* Dummy typedef */
63 typedef struct _GFileEnumerator GFileEnumerator;
64 typedef struct _GFileMonitor GFileMonitor;
65 typedef struct _GFilterInputStream GFilterInputStream;
66 typedef struct _GFilterOutputStream GFilterOutputStream;
71 * A handle to an object implementing the #GFileIface interface.
72 * Generally stores a location within the file system. Handles do not
73 * necessarily represent files or directories that currently exist.
75 typedef struct _GFile GFile; /* Dummy typedef */
76 typedef struct _GFileInfo GFileInfo;
79 * GFileAttributeMatcher:
81 * Determines if a string matches a file attribute.
83 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
84 typedef struct _GFileAttributeInfo GFileAttributeInfo;
85 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
86 typedef struct _GFileDescriptorBased GFileDescriptorBased;
87 typedef struct _GFileInputStream GFileInputStream;
88 typedef struct _GFileOutputStream GFileOutputStream;
89 typedef struct _GFileIOStream GFileIOStream;
90 typedef struct _GFileIcon GFileIcon;
91 typedef struct _GFilenameCompleter GFilenameCompleter;
94 typedef struct _GIcon GIcon; /* Dummy typedef */
95 typedef struct _GInetAddress GInetAddress;
96 typedef struct _GInetSocketAddress GInetSocketAddress;
97 typedef struct _GInputStream GInputStream;
98 typedef struct _GInitable GInitable;
99 typedef struct _GIOModule GIOModule;
100 typedef struct _GIOExtensionPoint GIOExtensionPoint;
101 typedef struct _GIOExtension GIOExtension;
106 * Opaque class for definining and scheduling IO jobs.
108 typedef struct _GIOSchedulerJob GIOSchedulerJob;
109 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
110 typedef struct _GMemoryInputStream GMemoryInputStream;
111 typedef struct _GMemoryOutputStream GMemoryOutputStream;
116 * A handle to an object implementing the #GMountIface interface.
118 typedef struct _GMount GMount; /* Dummy typedef */
119 typedef struct _GMountOperation GMountOperation;
120 typedef struct _GNetworkAddress GNetworkAddress;
121 typedef struct _GNetworkService GNetworkService;
122 typedef struct _GOutputStream GOutputStream;
123 typedef struct _GIOStream GIOStream;
124 typedef struct _GResolver GResolver;
125 typedef struct _GSeekable GSeekable;
126 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
131 * A lowlevel network socket object.
135 typedef struct _GSocket GSocket;
138 * GSocketControlMessage:
140 * Base class for socket-type specific control messages that can be sent and
141 * received over #GSocket.
143 typedef struct _GSocketControlMessage GSocketControlMessage;
147 * A helper class for network clients to make connections.
151 typedef struct _GSocketClient GSocketClient;
155 * A socket connection GIOStream object for connection-oriented sockets.
159 typedef struct _GSocketConnection GSocketConnection;
163 * A helper class for network servers to listen for and accept connections.
167 typedef struct _GSocketListener GSocketListener;
171 * A helper class for handling accepting incomming connections in the
176 typedef struct _GSocketService GSocketService;
177 typedef struct _GSocketAddress GSocketAddress;
178 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
179 typedef struct _GSocketConnectable GSocketConnectable;
180 typedef struct _GSrvTarget GSrvTarget;
184 * A #GSocketConnection for TCP/IP connections.
188 typedef struct _GTcpConnection GTcpConnection;
190 * GThreadedSocketService:
192 * A helper class for handling accepting incomming connections in the
193 * glib mainloop and handling them in a thread.
197 typedef struct _GThreadedSocketService GThreadedSocketService;
198 typedef struct _GThemedIcon GThemedIcon;
199 typedef struct _GVfs GVfs; /* Dummy typedef */
204 * A helper class to enumerate proxies base on URI.
208 typedef struct _GProxyResolver GProxyResolver;
209 typedef struct _GProxy GProxy;
210 typedef struct _GProxyAddress GProxyAddress;
211 typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator;
216 * Opaque mountable volume object.
218 typedef struct _GVolume GVolume; /* Dummy typedef */
219 typedef struct _GVolumeMonitor GVolumeMonitor;
222 * GAsyncReadyCallback:
223 * @source_object: the object the asynchronous operation was started with.
224 * @res: a #GAsyncResult.
225 * @user_data: user data passed to the callback.
227 * Type definition for a function that will be called back when an asynchronous
228 * operation within GIO has been completed.
230 typedef void (*GAsyncReadyCallback) (GObject *source_object,
235 * GFileProgressCallback:
236 * @current_num_bytes: the current number of bytes in the operation.
237 * @total_num_bytes: the total number of bytes in the operation.
238 * @user_data: user data passed to the callback.
240 * When doing file operations that may take a while, such as moving
241 * a file or copying a file, a progress callback is used to pass how
242 * far along that operation is to the application.
244 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
245 goffset total_num_bytes,
249 * GFileReadMoreCallback:
250 * @file_contents: the data as currently read.
251 * @file_size: the size of the data currently read.
252 * @callback_data: data passed to the callback.
254 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
255 * it may become necessary to determine if any more data from the file should be loaded.
256 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
257 * should be read, or %FALSE otherwise.
259 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
261 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
263 gpointer callback_data);
267 * GIOSchedulerJobFunc:
268 * @job: a #GIOSchedulerJob.
269 * @cancellable: optional #GCancellable object, %NULL to ignore.
270 * @user_data: the data to pass to callback function
274 * Note that depending on whether threads are available, the
275 * #GIOScheduler may run jobs in separate threads or in an idle
278 * Long-running jobs should periodically check the @cancellable
279 * to see if they have been cancelled.
281 * Returns: %TRUE if this function should be called again to
282 * complete the job, %FALSE if the job is complete (or cancelled)
284 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
285 GCancellable *cancellable,
289 * GSimpleAsyncThreadFunc:
290 * @res: a #GSimpleAsyncResult.
291 * @object: a #GObject.
292 * @cancellable: optional #GCancellable object, %NULL to ignore.
294 * Simple thread function that runs an asynchronous operation and
295 * checks for cancellation.
297 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
299 GCancellable *cancellable);
303 * @socket: the #GSocket
304 * @condition: the current condition at the source fired.
305 * @user_data: data passed in by the user.
307 * This is the function type of the callback used for the #GSource
308 * returned by g_socket_create_source().
310 * Returns: it should return %FALSE if the source should be removed.
314 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
315 GIOCondition condition,
320 * @buffer: Pointer to a buffer where data will be written.
321 * @size: the available size in @buffer.
323 * Structure used for scatter/gather data input.
324 * You generally pass in an array of #GInputVector<!-- -->s
325 * and the operation will store the read data starting in the
326 * first buffer, switching to the next as needed.
330 typedef struct _GInputVector GInputVector;
332 struct _GInputVector {
339 * @buffer: Pointer to a buffer of data to read.
340 * @size: the size of @buffer.
342 * Structure used for scatter/gather data output.
343 * You generally pass in an array of #GOutputVector<!-- -->s
344 * and the operation will use all the buffers as if they were
349 typedef struct _GOutputVector GOutputVector;
351 struct _GOutputVector {
352 gconstpointer buffer;
356 typedef struct _GCredentials GCredentials;
357 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;
358 typedef struct _GUnixFDList GUnixFDList;
359 typedef struct _GDBusMessage GDBusMessage;
360 typedef struct _GDBusConnection GDBusConnection;
361 typedef struct _GDBusProxy GDBusProxy;
362 typedef struct _GDBusMethodInvocation GDBusMethodInvocation;
363 typedef struct _GDBusServer GDBusServer;
364 typedef struct _GDBusAuthObserver GDBusAuthObserver;
365 typedef struct _GDBusErrorEntry GDBusErrorEntry;
366 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
367 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable;
368 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo;
369 typedef struct _GDBusArgInfo GDBusArgInfo;
370 typedef struct _GDBusMethodInfo GDBusMethodInfo;
371 typedef struct _GDBusSignalInfo GDBusSignalInfo;
372 typedef struct _GDBusPropertyInfo GDBusPropertyInfo;
373 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
374 typedef struct _GDBusNodeInfo GDBusNodeInfo;
378 #endif /* __GIO_TYPES_H__ */