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 _GDataInputStream GDataInputStream;
46 * Opaque drive object.
48 typedef struct _GDrive GDrive; /* Dummy typedef */
49 typedef struct _GFileEnumerator GFileEnumerator;
50 typedef struct _GFileMonitor GFileMonitor;
51 typedef struct _GFilterInputStream GFilterInputStream;
52 typedef struct _GFilterOutputStream GFilterOutputStream;
57 * A handle to an object implementing the #GFileIface interface.
58 * Generally stores a location within the file system. Handles do not
59 * necessarily represent files or directories that currently exist.
61 typedef struct _GFile GFile; /* Dummy typedef */
62 typedef struct _GFileInfo GFileInfo;
65 * GFileAttributeMatcher:
67 * Determines if a string matches a file attribute.
69 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
70 typedef struct _GFileAttributeInfo GFileAttributeInfo;
71 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
72 typedef struct _GFileInputStream GFileInputStream;
73 typedef struct _GFileOutputStream GFileOutputStream;
74 typedef struct _GFileIOStream GFileIOStream;
75 typedef struct _GFileIcon GFileIcon;
76 typedef struct _GFilenameCompleter GFilenameCompleter;
79 typedef struct _GIcon GIcon; /* Dummy typedef */
80 typedef struct _GInetAddress GInetAddress;
81 typedef struct _GInetSocketAddress GInetSocketAddress;
82 typedef struct _GInputStream GInputStream;
83 typedef struct _GInitable GInitable;
84 typedef struct _GIOModule GIOModule;
85 typedef struct _GIOExtensionPoint GIOExtensionPoint;
86 typedef struct _GIOExtension GIOExtension;
91 * Opaque class for definining and scheduling IO jobs.
93 typedef struct _GIOSchedulerJob GIOSchedulerJob;
94 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
95 typedef struct _GMemoryInputStream GMemoryInputStream;
96 typedef struct _GMemoryOutputStream GMemoryOutputStream;
101 * A handle to an object implementing the #GMountIface interface.
103 typedef struct _GMount GMount; /* Dummy typedef */
104 typedef struct _GMountOperation GMountOperation;
105 typedef struct _GNetworkAddress GNetworkAddress;
106 typedef struct _GNetworkService GNetworkService;
107 typedef struct _GOutputStream GOutputStream;
108 typedef struct _GIOStream GIOStream;
109 typedef struct _GResolver GResolver;
110 typedef struct _GSeekable GSeekable;
111 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
116 * A lowlevel network socket object.
120 typedef struct _GSocket GSocket;
123 * GSocketControlMessage:
125 * Base class for socket-type specific control messages that can be sent and
126 * received over #GSocket.
128 typedef struct _GSocketControlMessage GSocketControlMessage;
132 * A helper class for network clients to make connections.
136 typedef struct _GSocketClient GSocketClient;
140 * A socket connection GIOStream object for connection-oriented sockets.
144 typedef struct _GSocketConnection GSocketConnection;
148 * A helper class for network servers to listen for and accept connections.
152 typedef struct _GSocketListener GSocketListener;
156 * A helper class for handling accepting incomming connections in the
161 typedef struct _GSocketService GSocketService;
162 typedef struct _GSocketAddress GSocketAddress;
163 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
164 typedef struct _GSocketConnectable GSocketConnectable;
165 typedef struct _GSrvTarget GSrvTarget;
169 * A #GSocketConnection for TCP/IP connections.
173 typedef struct _GTcpConnection GTcpConnection;
175 * GThreadedSocketService:
177 * A helper class for handling accepting incomming connections in the
178 * glib mainloop and handling them in a thread.
182 typedef struct _GThreadedSocketService GThreadedSocketService;
183 typedef struct _GThemedIcon GThemedIcon;
184 typedef struct _GVfs GVfs; /* Dummy typedef */
189 * Opaque mountable volume object.
191 typedef struct _GVolume GVolume; /* Dummy typedef */
192 typedef struct _GVolumeMonitor GVolumeMonitor;
195 * GAsyncReadyCallback:
196 * @source_object: the object the asynchronous operation was started with.
197 * @res: a #GAsyncResult.
198 * @user_data: user data passed to the callback.
200 * Type definition for a function that will be called back when an asynchronous
201 * operation within GIO has been completed.
203 typedef void (*GAsyncReadyCallback) (GObject *source_object,
208 * GFileProgressCallback:
209 * @current_num_bytes: the current number of bytes in the operation.
210 * @total_num_bytes: the total number of bytes in the operation.
211 * @user_data: user data passed to the callback.
213 * When doing file operations that may take a while, such as moving
214 * a file or copying a file, a progress callback is used to pass how
215 * far along that operation is to the application.
217 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
218 goffset total_num_bytes,
222 * GFileReadMoreCallback:
223 * @file_contents: the data as currently read.
224 * @file_size: the size of the data currently read.
225 * @callback_data: data passed to the callback.
227 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
228 * it may become necessary to determine if any more data from the file should be loaded.
229 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
230 * should be read, or %FALSE otherwise.
232 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
234 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
236 gpointer callback_data);
240 * GIOSchedulerJobFunc:
241 * @job: a #GIOSchedulerJob.
242 * @cancellable: optional #GCancellable object, %NULL to ignore.
243 * @user_data: the data to pass to callback function
247 * Note that depending on whether threads are available, the
248 * #GIOScheduler may run jobs in separate threads or in an idle
251 * Long-running jobs should periodically check the @cancellable
252 * to see if they have been cancelled.
254 * Returns: %TRUE if this function should be called again to
255 * complete the job, %FALSE if the job is complete (or cancelled)
257 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
258 GCancellable *cancellable,
262 * GSimpleAsyncThreadFunc:
263 * @res: a #GSimpleAsyncResult.
264 * @object: a #GObject.
265 * @cancellable: optional #GCancellable object, %NULL to ignore.
267 * Simple thread function that runs an asynchronous operation and
268 * checks for cancellation.
270 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
272 GCancellable *cancellable);
276 * @socket: the #GSocket
277 * @condition: the current condition at the source fired.
278 * @user_data: data passed in by the user.
280 * This is the function type of the callback used for the #GSource
281 * returned by g_socket_create_source().
283 * Returns: it should return FALSE if the source should be removed.
287 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
288 GIOCondition condition,
293 * @buffer: Pointer to a buffer where data will be written.
294 * @size: the availible size in @buffer.
296 * Structure used for scatter/gather data input.
297 * You generally pass in an array of #GInputVector<!-- -->s and the operation
298 * will store the read data starting in the first buffer, switching to
299 * the next as needed.
303 typedef struct _GInputVector GInputVector;
305 struct _GInputVector {
312 * @buffer: Pointer to a buffer of data to read.
313 * @size: the size of @buffer.
315 * Structure used for scatter/gather data output.
316 * You generally pass in an array of #GOutputVector<!-- -->s and the operation
317 * will use all the buffers as if they were one buffer.
321 typedef struct _GOutputVector GOutputVector;
323 struct _GOutputVector {
324 gconstpointer buffer;
331 #endif /* __GIO_TYPES_H__ */