gio/giotypes.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __GIO_TYPES_H__
  28 #define __GIO_TYPES_H__
  29
  30 #include <gio/gioenums.h>
  31
  32 G_BEGIN_DECLS
  33
  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;
  42
  43 /**
  44  * GDrive:
  45  *
  46  * Opaque drive object.
  47  **/
  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;
  53
  54 /**
  55  * GFile:
  56  *
  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.
  60  **/
  61 typedef struct _GFile                         GFile; /* Dummy typedef */
  62 typedef struct _GFileInfo                     GFileInfo;
  63
  64 /**
  65  * GFileAttributeMatcher:
  66  *
  67  * Determines if a string matches a file attribute.
  68  **/
  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;
  77
  78
  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;
  87
  88 /**
  89  * GIOSchedulerJob:
  90  *
  91  * Opaque class for definining and scheduling IO jobs.
  92  **/
  93 typedef struct _GIOSchedulerJob               GIOSchedulerJob;
  94 typedef struct _GLoadableIcon                 GLoadableIcon; /* Dummy typedef */
  95 typedef struct _GMemoryInputStream            GMemoryInputStream;
  96 typedef struct _GMemoryOutputStream           GMemoryOutputStream;
  97
  98 /**
  99  * GMount:
 100  *
 101  * A handle to an object implementing the #GMountIface interface.
 102  **/
 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;
 112
 113 /**
 114  * GSocket:
 115  *
 116  * A lowlevel network socket object.
 117  *
 118  * Since: 2.22
 119  **/
 120 typedef struct _GSocket                       GSocket;
 121
 122 /**
 123  * GSocketControlMessage:
 124  *
 125  * Base class for socket-type specific control messages that can be sent and
 126  * received over #GSocket.
 127  **/
 128 typedef struct _GSocketControlMessage         GSocketControlMessage;
 129 /**
 130  * GSocketClient:
 131  *
 132  * A helper class for network clients to make connections.
 133  *
 134  * Since: 2.22
 135  **/
 136 typedef struct _GSocketClient                               GSocketClient;
 137 /**
 138  * GSocketConnection:
 139  *
 140  * A socket connection GIOStream object for connection-oriented sockets.
 141  *
 142  * Since: 2.22
 143  **/
 144 typedef struct _GSocketConnection                           GSocketConnection;
 145 /**
 146  * GSocketClient:
 147  *
 148  * A helper class for network servers to listen for and accept connections.
 149  *
 150  * Since: 2.22
 151  **/
 152 typedef struct _GSocketListener                             GSocketListener;
 153 /**
 154  * GSocketService:
 155  *
 156  * A helper class for handling accepting incomming connections in the
 157  * glib mainloop.
 158  *
 159  * Since: 2.22
 160  **/
 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;
 166 /**
 167  * GTcpConnection:
 168  *
 169  * A #GSocketConnection for TCP/IP connections.
 170  *
 171  * Since: 2.22
 172  **/
 173 typedef struct _GTcpConnection                              GTcpConnection;
 174 /**
 175  * GThreadedSocketService:
 176  *
 177  * A helper class for handling accepting incomming connections in the
 178  * glib mainloop and handling them in a thread.
 179  *
 180  * Since: 2.22
 181  **/
 182 typedef struct _GThreadedSocketService                      GThreadedSocketService;
 183 typedef struct _GThemedIcon                   GThemedIcon;
 184 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 185
 186 /**
 187  * GVolume:
 188  *
 189  * Opaque mountable volume object.
 190  **/
 191 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 192 typedef struct _GVolumeMonitor                GVolumeMonitor;
 193
 194 /**
 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.
 199  *
 200  * Type definition for a function that will be called back when an asynchronous
 201  * operation within GIO has been completed.
 202  **/
 203 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 204                                      GAsyncResult *res,
 205                                      gpointer user_data);
 206
 207 /**
 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.
 212  *
 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.
 216  **/
 217 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 218                                        goffset total_num_bytes,
 219                                        gpointer user_data);
 220
 221 /**
 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.
 226  *
 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.
 231  *
 232  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 233  **/
 234 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 235                                             goffset file_size,
 236                                             gpointer callback_data);
 237
 238
 239 /**
 240  * GIOSchedulerJobFunc:
 241  * @job: a #GIOSchedulerJob.
 242  * @cancellable: optional #GCancellable object, %NULL to ignore.
 243  * @user_data: the data to pass to callback function
 244  *
 245  * I/O Job function.
 246  *
 247  * Note that depending on whether threads are available, the
 248  * #GIOScheduler may run jobs in separate threads or in an idle
 249  * in the mainloop.
 250  *
 251  * Long-running jobs should periodically check the @cancellable
 252  * to see if they have been cancelled.
 253  *
 254  * Returns: %TRUE if this function should be called again to
 255  *    complete the job, %FALSE if the job is complete (or cancelled)
 256  **/
 257 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 258                                          GCancellable    *cancellable,
 259                                          gpointer         user_data);
 260
 261 /**
 262  * GSimpleAsyncThreadFunc:
 263  * @res: a #GSimpleAsyncResult.
 264  * @object: a #GObject.
 265  * @cancellable: optional #GCancellable object, %NULL to ignore.
 266  *
 267  * Simple thread function that runs an asynchronous operation and
 268  * checks for cancellation.
 269  **/
 270 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 271                                         GObject *object,
 272                                         GCancellable *cancellable);
 273
 274 /**
 275  * GSocketSourceFunc:
 276  * @socket: the #GSocket
 277  * @condition: the current condition at the source fired.
 278  * @user_data: data passed in by the user.
 279  *
 280  * This is the function type of the callback used for the #GSource
 281  * returned by g_socket_create_source().
 282  *
 283  * Returns: it should return FALSE if the source should be removed.
 284  *
 285  * Since: 2.22
 286  */
 287 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
 288                                        GIOCondition condition,
 289                                        gpointer user_data);
 290
 291 /**
 292  * GInputVector:
 293  *
 294  * Structure used for scatter/gather data input.
 295  *
 296  * Since: 2.22
 297  */
 298 typedef struct
 299 {
 300   gpointer buffer;
 301   gsize size;
 302 } GInputVector;
 303
 304 /**
 305  * GOutputVector:
 306  *
 307  * Structure used for scatter/gather data output.
 308  *
 309  * Since: 2.22
 310  */
 311 typedef struct
 312 {
 313   gconstpointer buffer;
 314   gsize size;
 315 } GOutputVector;
 316
 317
 318 G_END_DECLS
 319
 320 #endif /* __GIO_TYPES_H__ */