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 _GZlibCompressor GZlibCompressor;
47 typedef struct _GZlibDecompressor GZlibDecompressor;
52 * Opaque drive object.
54 typedef struct _GDrive GDrive; /* Dummy typedef */
55 typedef struct _GFileEnumerator GFileEnumerator;
56 typedef struct _GFileMonitor GFileMonitor;
57 typedef struct _GFilterInputStream GFilterInputStream;
58 typedef struct _GFilterOutputStream GFilterOutputStream;
63 * A handle to an object implementing the #GFileIface interface.
64 * Generally stores a location within the file system. Handles do not
65 * necessarily represent files or directories that currently exist.
67 typedef struct _GFile GFile; /* Dummy typedef */
68 typedef struct _GFileInfo GFileInfo;
71 * GFileAttributeMatcher:
73 * Determines if a string matches a file attribute.
75 typedef struct _GFileAttributeMatcher GFileAttributeMatcher;
76 typedef struct _GFileAttributeInfo GFileAttributeInfo;
77 typedef struct _GFileAttributeInfoList GFileAttributeInfoList;
78 typedef struct _GFileDescriptorBased GFileDescriptorBased;
79 typedef struct _GFileInputStream GFileInputStream;
80 typedef struct _GFileOutputStream GFileOutputStream;
81 typedef struct _GFileIOStream GFileIOStream;
82 typedef struct _GFileIcon GFileIcon;
83 typedef struct _GFilenameCompleter GFilenameCompleter;
86 typedef struct _GIcon GIcon; /* Dummy typedef */
87 typedef struct _GInetAddress GInetAddress;
88 typedef struct _GInetSocketAddress GInetSocketAddress;
89 typedef struct _GInputStream GInputStream;
90 typedef struct _GInitable GInitable;
91 typedef struct _GIOModule GIOModule;
92 typedef struct _GIOExtensionPoint GIOExtensionPoint;
93 typedef struct _GIOExtension GIOExtension;
98 * Opaque class for definining and scheduling IO jobs.
100 typedef struct _GIOSchedulerJob GIOSchedulerJob;
101 typedef struct _GLoadableIcon GLoadableIcon; /* Dummy typedef */
102 typedef struct _GMemoryInputStream GMemoryInputStream;
103 typedef struct _GMemoryOutputStream GMemoryOutputStream;
108 * A handle to an object implementing the #GMountIface interface.
110 typedef struct _GMount GMount; /* Dummy typedef */
111 typedef struct _GMountOperation GMountOperation;
112 typedef struct _GNetworkAddress GNetworkAddress;
113 typedef struct _GNetworkService GNetworkService;
114 typedef struct _GOutputStream GOutputStream;
115 typedef struct _GIOStream GIOStream;
116 typedef struct _GResolver GResolver;
117 typedef struct _GSeekable GSeekable;
118 typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
123 * A lowlevel network socket object.
127 typedef struct _GSocket GSocket;
130 * GSocketControlMessage:
132 * Base class for socket-type specific control messages that can be sent and
133 * received over #GSocket.
135 typedef struct _GSocketControlMessage GSocketControlMessage;
139 * A helper class for network clients to make connections.
143 typedef struct _GSocketClient GSocketClient;
147 * A socket connection GIOStream object for connection-oriented sockets.
151 typedef struct _GSocketConnection GSocketConnection;
155 * A helper class for network servers to listen for and accept connections.
159 typedef struct _GSocketListener GSocketListener;
163 * A helper class for handling accepting incomming connections in the
168 typedef struct _GSocketService GSocketService;
169 typedef struct _GSocketAddress GSocketAddress;
170 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator;
171 typedef struct _GSocketConnectable GSocketConnectable;
172 typedef struct _GSrvTarget GSrvTarget;
176 * A #GSocketConnection for TCP/IP connections.
180 typedef struct _GTcpConnection GTcpConnection;
182 * GThreadedSocketService:
184 * A helper class for handling accepting incomming connections in the
185 * glib mainloop and handling them in a thread.
189 typedef struct _GThreadedSocketService GThreadedSocketService;
190 typedef struct _GThemedIcon GThemedIcon;
191 typedef struct _GVfs GVfs; /* Dummy typedef */
196 * Opaque mountable volume object.
198 typedef struct _GVolume GVolume; /* Dummy typedef */
199 typedef struct _GVolumeMonitor GVolumeMonitor;
202 * GAsyncReadyCallback:
203 * @source_object: the object the asynchronous operation was started with.
204 * @res: a #GAsyncResult.
205 * @user_data: user data passed to the callback.
207 * Type definition for a function that will be called back when an asynchronous
208 * operation within GIO has been completed.
210 typedef void (*GAsyncReadyCallback) (GObject *source_object,
215 * GFileProgressCallback:
216 * @current_num_bytes: the current number of bytes in the operation.
217 * @total_num_bytes: the total number of bytes in the operation.
218 * @user_data: user data passed to the callback.
220 * When doing file operations that may take a while, such as moving
221 * a file or copying a file, a progress callback is used to pass how
222 * far along that operation is to the application.
224 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
225 goffset total_num_bytes,
229 * GFileReadMoreCallback:
230 * @file_contents: the data as currently read.
231 * @file_size: the size of the data currently read.
232 * @callback_data: data passed to the callback.
234 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
235 * it may become necessary to determine if any more data from the file should be loaded.
236 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
237 * should be read, or %FALSE otherwise.
239 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
241 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
243 gpointer callback_data);
247 * GIOSchedulerJobFunc:
248 * @job: a #GIOSchedulerJob.
249 * @cancellable: optional #GCancellable object, %NULL to ignore.
250 * @user_data: the data to pass to callback function
254 * Note that depending on whether threads are available, the
255 * #GIOScheduler may run jobs in separate threads or in an idle
258 * Long-running jobs should periodically check the @cancellable
259 * to see if they have been cancelled.
261 * Returns: %TRUE if this function should be called again to
262 * complete the job, %FALSE if the job is complete (or cancelled)
264 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
265 GCancellable *cancellable,
269 * GSimpleAsyncThreadFunc:
270 * @res: a #GSimpleAsyncResult.
271 * @object: a #GObject.
272 * @cancellable: optional #GCancellable object, %NULL to ignore.
274 * Simple thread function that runs an asynchronous operation and
275 * checks for cancellation.
277 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
279 GCancellable *cancellable);
283 * @socket: the #GSocket
284 * @condition: the current condition at the source fired.
285 * @user_data: data passed in by the user.
287 * This is the function type of the callback used for the #GSource
288 * returned by g_socket_create_source().
290 * Returns: it should return %FALSE if the source should be removed.
294 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
295 GIOCondition condition,
300 * @buffer: Pointer to a buffer where data will be written.
301 * @size: the available size in @buffer.
303 * Structure used for scatter/gather data input.
304 * You generally pass in an array of #GInputVector<!-- -->s
305 * and the operation will store the read data starting in the
306 * first buffer, switching to the next as needed.
310 typedef struct _GInputVector GInputVector;
312 struct _GInputVector {
319 * @buffer: Pointer to a buffer of data to read.
320 * @size: the size of @buffer.
322 * Structure used for scatter/gather data output.
323 * You generally pass in an array of #GOutputVector<!-- -->s
324 * and the operation will use all the buffers as if they were
329 typedef struct _GOutputVector GOutputVector;
331 struct _GOutputVector {
332 gconstpointer buffer;
339 #endif /* __GIO_TYPES_H__ */