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 _GDBusActionGroup GDBusActionGroup
;
52 typedef struct _GActionMap GActionMap
;
53 typedef struct _GActionGroup GActionGroup
;
54 typedef struct _GSimpleAction GSimpleAction
;
55 typedef struct _GAction GAction
;
56 typedef struct _GApplication GApplication
;
57 typedef struct _GApplicationCommandLine GApplicationCommandLine
;
58 typedef struct _GSettingsBackend GSettingsBackend
;
59 typedef struct _GSettings GSettings
;
60 typedef struct _GPermission GPermission
;
62 typedef struct _GMenuModel GMenuModel
;
67 * Opaque drive object.
69 typedef struct _GDrive GDrive
; /* Dummy typedef */
70 typedef struct _GFileEnumerator GFileEnumerator
;
71 typedef struct _GFileMonitor GFileMonitor
;
72 typedef struct _GFilterInputStream GFilterInputStream
;
73 typedef struct _GFilterOutputStream GFilterOutputStream
;
78 * A handle to an object implementing the #GFileIface interface.
79 * Generally stores a location within the file system. Handles do not
80 * necessarily represent files or directories that currently exist.
82 typedef struct _GFile GFile
; /* Dummy typedef */
83 typedef struct _GFileInfo GFileInfo
;
86 * GFileAttributeMatcher:
88 * Determines if a string matches a file attribute.
90 typedef struct _GFileAttributeMatcher GFileAttributeMatcher
;
91 typedef struct _GFileAttributeInfo GFileAttributeInfo
;
92 typedef struct _GFileAttributeInfoList GFileAttributeInfoList
;
93 typedef struct _GFileDescriptorBased GFileDescriptorBased
;
94 typedef struct _GFileInputStream GFileInputStream
;
95 typedef struct _GFileOutputStream GFileOutputStream
;
96 typedef struct _GFileIOStream GFileIOStream
;
97 typedef struct _GFileIcon GFileIcon
;
98 typedef struct _GFilenameCompleter GFilenameCompleter
;
101 typedef struct _GIcon GIcon
; /* Dummy typedef */
102 typedef struct _GInetAddress GInetAddress
;
103 typedef struct _GInetAddressMask GInetAddressMask
;
104 typedef struct _GInetSocketAddress GInetSocketAddress
;
105 typedef struct _GInputStream GInputStream
;
106 typedef struct _GInitable GInitable
;
107 typedef struct _GIOModule GIOModule
;
108 typedef struct _GIOExtensionPoint GIOExtensionPoint
;
109 typedef struct _GIOExtension GIOExtension
;
114 * Opaque class for defining and scheduling IO jobs.
116 typedef struct _GIOSchedulerJob GIOSchedulerJob
;
117 typedef struct _GIOStreamAdapter GIOStreamAdapter
;
118 typedef struct _GLoadableIcon GLoadableIcon
; /* Dummy typedef */
119 typedef struct _GMemoryInputStream GMemoryInputStream
;
120 typedef struct _GMemoryOutputStream GMemoryOutputStream
;
125 * A handle to an object implementing the #GMountIface interface.
127 typedef struct _GMount GMount
; /* Dummy typedef */
128 typedef struct _GMountOperation GMountOperation
;
129 typedef struct _GNetworkAddress GNetworkAddress
;
130 typedef struct _GNetworkMonitor GNetworkMonitor
;
131 typedef struct _GNetworkService GNetworkService
;
132 typedef struct _GOutputStream GOutputStream
;
133 typedef struct _GIOStream GIOStream
;
134 typedef struct _GPollableInputStream GPollableInputStream
; /* Dummy typedef */
135 typedef struct _GPollableOutputStream GPollableOutputStream
; /* Dummy typedef */
136 typedef struct _GResolver GResolver
;
137 typedef struct _GSeekable GSeekable
;
138 typedef struct _GSimpleAsyncResult GSimpleAsyncResult
;
143 * A lowlevel network socket object.
147 typedef struct _GSocket GSocket
;
150 * GSocketControlMessage:
152 * Base class for socket-type specific control messages that can be sent and
153 * received over #GSocket.
155 typedef struct _GSocketControlMessage GSocketControlMessage
;
159 * A helper class for network clients to make connections.
163 typedef struct _GSocketClient GSocketClient
;
167 * A socket connection GIOStream object for connection-oriented sockets.
171 typedef struct _GSocketConnection GSocketConnection
;
175 * A helper class for network servers to listen for and accept connections.
179 typedef struct _GSocketListener GSocketListener
;
183 * A helper class for handling accepting incomming connections in the
188 typedef struct _GSocketService GSocketService
;
189 typedef struct _GSocketAddress GSocketAddress
;
190 typedef struct _GSocketAddressEnumerator GSocketAddressEnumerator
;
191 typedef struct _GSocketConnectable GSocketConnectable
;
192 typedef struct _GSrvTarget GSrvTarget
;
196 * A #GSocketConnection for TCP/IP connections.
200 typedef struct _GTcpConnection GTcpConnection
;
201 typedef struct _GTcpWrapperConnection GTcpWrapperConnection
;
203 * GThreadedSocketService:
205 * A helper class for handling accepting incoming connections in the
206 * glib mainloop and handling them in a thread.
210 typedef struct _GThreadedSocketService GThreadedSocketService
;
211 typedef struct _GThemedIcon GThemedIcon
;
212 typedef struct _GTlsCertificate GTlsCertificate
;
213 typedef struct _GTlsClientConnection GTlsClientConnection
; /* Dummy typedef */
214 typedef struct _GTlsConnection GTlsConnection
;
215 typedef struct _GTlsDatabase GTlsDatabase
;
216 typedef struct _GTlsFileDatabase GTlsFileDatabase
;
217 typedef struct _GTlsInteraction GTlsInteraction
;
218 typedef struct _GTlsPassword GTlsPassword
;
219 typedef struct _GTlsServerConnection GTlsServerConnection
; /* Dummy typedef */
220 typedef struct _GVfs GVfs
; /* Dummy typedef */
225 * A helper class to enumerate proxies base on URI.
229 typedef struct _GProxyResolver GProxyResolver
;
230 typedef struct _GProxy GProxy
;
231 typedef struct _GProxyAddress GProxyAddress
;
232 typedef struct _GProxyAddressEnumerator GProxyAddressEnumerator
;
237 * Opaque mountable volume object.
239 typedef struct _GVolume GVolume
; /* Dummy typedef */
240 typedef struct _GVolumeMonitor GVolumeMonitor
;
243 * GAsyncReadyCallback:
244 * @source_object: the object the asynchronous operation was started with.
245 * @res: a #GAsyncResult.
246 * @user_data: user data passed to the callback.
248 * Type definition for a function that will be called back when an asynchronous
249 * operation within GIO has been completed.
251 typedef void (*GAsyncReadyCallback
) (GObject
*source_object
,
256 * GFileProgressCallback:
257 * @current_num_bytes: the current number of bytes in the operation.
258 * @total_num_bytes: the total number of bytes in the operation.
259 * @user_data: user data passed to the callback.
261 * When doing file operations that may take a while, such as moving
262 * a file or copying a file, a progress callback is used to pass how
263 * far along that operation is to the application.
265 typedef void (*GFileProgressCallback
) (goffset current_num_bytes
,
266 goffset total_num_bytes
,
270 * GFileReadMoreCallback:
271 * @file_contents: the data as currently read.
272 * @file_size: the size of the data currently read.
273 * @callback_data: data passed to the callback.
275 * When loading the partial contents of a file with g_file_load_partial_contents_async(),
276 * it may become necessary to determine if any more data from the file should be loaded.
277 * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
278 * should be read, or %FALSE otherwise.
280 * Returns: %TRUE if more data should be read back. %FALSE otherwise.
282 typedef gboolean (* GFileReadMoreCallback
) (const char *file_contents
,
284 gpointer callback_data
);
288 * GIOSchedulerJobFunc:
289 * @job: a #GIOSchedulerJob.
290 * @cancellable: optional #GCancellable object, %NULL to ignore.
291 * @user_data: the data to pass to callback function
295 * Long-running jobs should periodically check the @cancellable
296 * to see if they have been cancelled.
298 * Returns: %TRUE if this function should be called again to
299 * complete the job, %FALSE if the job is complete (or cancelled)
301 typedef gboolean (*GIOSchedulerJobFunc
) (GIOSchedulerJob
*job
,
302 GCancellable
*cancellable
,
306 * GSimpleAsyncThreadFunc:
307 * @res: a #GSimpleAsyncResult.
308 * @object: a #GObject.
309 * @cancellable: optional #GCancellable object, %NULL to ignore.
311 * Simple thread function that runs an asynchronous operation and
312 * checks for cancellation.
314 typedef void (*GSimpleAsyncThreadFunc
) (GSimpleAsyncResult
*res
,
316 GCancellable
*cancellable
);
320 * @socket: the #GSocket
321 * @condition: the current condition at the source fired.
322 * @user_data: data passed in by the user.
324 * This is the function type of the callback used for the #GSource
325 * returned by g_socket_create_source().
327 * Returns: it should return %FALSE if the source should be removed.
331 typedef gboolean (*GSocketSourceFunc
) (GSocket
*socket
,
332 GIOCondition condition
,
337 * @buffer: Pointer to a buffer where data will be written.
338 * @size: the available size in @buffer.
340 * Structure used for scatter/gather data input.
341 * You generally pass in an array of #GInputVector<!-- -->s
342 * and the operation will store the read data starting in the
343 * first buffer, switching to the next as needed.
347 typedef struct _GInputVector GInputVector
;
349 struct _GInputVector
{
356 * @buffer: Pointer to a buffer of data to read.
357 * @size: the size of @buffer.
359 * Structure used for scatter/gather data output.
360 * You generally pass in an array of #GOutputVector<!-- -->s
361 * and the operation will use all the buffers as if they were
366 typedef struct _GOutputVector GOutputVector
;
368 struct _GOutputVector
{
369 gconstpointer buffer
;
373 typedef struct _GCredentials GCredentials
;
374 typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage
;
375 typedef struct _GUnixFDList GUnixFDList
;
376 typedef struct _GDBusMessage GDBusMessage
;
377 typedef struct _GDBusConnection GDBusConnection
;
378 typedef struct _GDBusProxy GDBusProxy
;
379 typedef struct _GDBusMethodInvocation GDBusMethodInvocation
;
380 typedef struct _GDBusServer GDBusServer
;
381 typedef struct _GDBusAuthObserver GDBusAuthObserver
;
382 typedef struct _GDBusErrorEntry GDBusErrorEntry
;
383 typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable
;
384 typedef struct _GDBusSubtreeVTable GDBusSubtreeVTable
;
385 typedef struct _GDBusAnnotationInfo GDBusAnnotationInfo
;
386 typedef struct _GDBusArgInfo GDBusArgInfo
;
387 typedef struct _GDBusMethodInfo GDBusMethodInfo
;
388 typedef struct _GDBusSignalInfo GDBusSignalInfo
;
389 typedef struct _GDBusPropertyInfo GDBusPropertyInfo
;
390 typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo
;
391 typedef struct _GDBusNodeInfo GDBusNodeInfo
;
394 * GCancellableSourceFunc:
395 * @cancellable: the #GCancellable
396 * @user_data: data passed in by the user.
398 * This is the function type of the callback used for the #GSource
399 * returned by g_cancellable_source_new().
401 * Returns: it should return %FALSE if the source should be removed.
405 typedef gboolean (*GCancellableSourceFunc
) (GCancellable
*cancellable
,
409 * GPollableSourceFunc:
410 * @pollable_stream: the #GPollableInputStream or #GPollableOutputStream
411 * @user_data: data passed in by the user.
413 * This is the function type of the callback used for the #GSource
414 * returned by g_pollable_input_stream_create_source() and
415 * g_pollable_output_stream_create_source().
417 * Returns: it should return %FALSE if the source should be removed.
421 typedef gboolean (*GPollableSourceFunc
) (GObject
*pollable_stream
,
424 typedef struct _GDBusInterface GDBusInterface
; /* Dummy typedef */
425 typedef struct _GDBusInterfaceSkeleton GDBusInterfaceSkeleton
;
426 typedef struct _GDBusObject GDBusObject
; /* Dummy typedef */
427 typedef struct _GDBusObjectSkeleton GDBusObjectSkeleton
;
428 typedef struct _GDBusObjectProxy GDBusObjectProxy
;
429 typedef struct _GDBusObjectManager GDBusObjectManager
; /* Dummy typedef */
430 typedef struct _GDBusObjectManagerClient GDBusObjectManagerClient
;
431 typedef struct _GDBusObjectManagerServer GDBusObjectManagerServer
;
434 * GDBusProxyTypeFunc:
435 * @manager: A #GDBusObjectManagerClient.
436 * @object_path: The object path of the remote object.
437 * @interface_name: (allow-none): The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested.
438 * @user_data: User data.
440 * Function signature for a function used to determine the #GType to
441 * use for an interface proxy (if @interface_name is not %NULL) or
442 * object proxy (if @interface_name is %NULL).
444 * This function is called in the
445 * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
446 * that @manager was constructed in.
448 * Returns: A #GType to use for the remote object. The returned type
449 * must be a #GDBusProxy<!-- -->- or #GDBusObjectProxy<!-- -->-derived
454 typedef GType (*GDBusProxyTypeFunc
) (GDBusObjectManagerClient
*manager
,
455 const gchar
*object_path
,
456 const gchar
*interface_name
,
461 #endif /* __GIO_TYPES_H__ */