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;
129 typedef struct _GSocketAddress GSocketAddress;
130 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
131 typedef struct _GSocketConnectable GSocketConnectable;
132 typedef struct _GSrvTarget GSrvTarget;
133 typedef struct _GThemedIcon GThemedIcon;
134 typedef struct _GVfs GVfs; /* Dummy typedef */
139 * Opaque mountable volume object.
141 typedef struct _GVolume GVolume; /* Dummy typedef */
142 typedef struct _GVolumeMonitor GVolumeMonitor;
145 * GAsyncReadyCallback:
146 * @source_object: the object the asynchronous operation was started with.
147 * @res: a #GAsyncResult.
148 * @user_data: user data passed to the callback.
150 * Type definition for a function that will be called back when an asynchronous
151 * operation within GIO has been completed.
153 typedef void (*GAsyncReadyCallback) (GObject *source_object,
158 * GFileProgressCallback:
159 * @current_num_bytes: the current number of bytes in the operation.
160 * @total_num_bytes: the total number of bytes in the operation.
161 * @user_data: user data passed to the callback.
163 * When doing file operations that may take a while, such as moving
164 * a file or copying a file, a progress callback is used to pass how
165 * far along that operation is to the application.
167 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
168 goffset total_num_bytes,
172 * GFileReadMoreCallback:
173 * @file_contents: the data as currently read.
174 * @file_size: the size of the data currently read.
175 * @callback_data: data passed to the callback.
177 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
178 * it may become necessary to determine if any more data from the file should be loaded.
179 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
180 * should be read, or %FALSE otherwise.
182 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
184 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
186 gpointer callback_data);
190 * GIOSchedulerJobFunc:
191 * @job: a #GIOSchedulerJob.
192 * @cancellable: optional #GCancellable object, %NULL to ignore.
193 * @user_data: the data to pass to callback function
197 * Note that depending on whether threads are available, the
198 * #GIOScheduler may run jobs in separate threads or in an idle
201 * Long-running jobs should periodically check the @cancellable
202 * to see if they have been cancelled.
204 * Returns: %TRUE if this function should be called again to
205 * complete the job, %FALSE if the job is complete (or cancelled)
207 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
208 GCancellable *cancellable,
212 * GSimpleAsyncThreadFunc:
213 * @res: a #GSimpleAsyncResult.
214 * @object: a #GObject.
215 * @cancellable: optional #GCancellable object, %NULL to ignore.
217 * Simple thread function that runs an asynchronous operation and
218 * checks for cancellation.
220 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
222 GCancellable *cancellable);
226 * @socket: the #GSocket
227 * @condition: the current condition at the source fired.
228 * @user_data: data passed in by the user.
230 * This is the function type of the callback used for the #GSource
231 * returned by g_socket_create_source().
235 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
236 GIOCondition condition,
242 * Structure used for scatter/gather data input.
255 * Structure used for scatter/gather data output.
261 gconstpointer buffer;
268 #endif /* __GIO_TYPES_H__ */