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 _GCharsetConverter             GCharsetConverter;
  42 typedef struct _GConverter                    GConverter;
  43 typedef struct _GConverterInputStream         GConverterInputStream;
  44 typedef struct _GConverterOutputStream        GConverterOutputStream;
  45 typedef struct _GDataInputStream              GDataInputStream;
  46
  47 /**
  48  * GDrive:
  49  *
  50  * Opaque drive object.
  51  **/
  52 typedef struct _GDrive                        GDrive; /* Dummy typedef */
  53 typedef struct _GFileEnumerator               GFileEnumerator;
  54 typedef struct _GFileMonitor                  GFileMonitor;
  55 typedef struct _GFilterInputStream            GFilterInputStream;
  56 typedef struct _GFilterOutputStream           GFilterOutputStream;
  57
  58 /**
  59  * GFile:
  60  *
  61  * A handle to an object implementing the #GFileIface interface.
  62  * Generally stores a location within the file system. Handles do not
  63  * necessarily represent files or directories that currently exist.
  64  **/
  65 typedef struct _GFile                         GFile; /* Dummy typedef */
  66 typedef struct _GFileInfo                     GFileInfo;
  67
  68 /**
  69  * GFileAttributeMatcher:
  70  *
  71  * Determines if a string matches a file attribute.
  72  **/
  73 typedef struct _GFileAttributeMatcher         GFileAttributeMatcher;
  74 typedef struct _GFileAttributeInfo            GFileAttributeInfo;
  75 typedef struct _GFileAttributeInfoList        GFileAttributeInfoList;
  76 typedef struct _GFileInputStream              GFileInputStream;
  77 typedef struct _GFileOutputStream             GFileOutputStream;
  78 typedef struct _GFileIOStream                 GFileIOStream;
  79 typedef struct _GFileIcon                     GFileIcon;
  80 typedef struct _GFilenameCompleter            GFilenameCompleter;
  81
  82
  83 typedef struct _GIcon                         GIcon; /* Dummy typedef */
  84 typedef struct _GInetAddress                  GInetAddress;
  85 typedef struct _GInetSocketAddress            GInetSocketAddress;
  86 typedef struct _GInputStream                  GInputStream;
  87 typedef struct _GInitable                     GInitable;
  88 typedef struct _GIOModule                     GIOModule;
  89 typedef struct _GIOExtensionPoint             GIOExtensionPoint;
  90 typedef struct _GIOExtension                  GIOExtension;
  91
  92 /**
  93  * GIOSchedulerJob:
  94  *
  95  * Opaque class for definining and scheduling IO jobs.
  96  **/
  97 typedef struct _GIOSchedulerJob               GIOSchedulerJob;
  98 typedef struct _GLoadableIcon                 GLoadableIcon; /* Dummy typedef */
  99 typedef struct _GMemoryInputStream            GMemoryInputStream;
 100 typedef struct _GMemoryOutputStream           GMemoryOutputStream;
 101
 102 /**
 103  * GMount:
 104  *
 105  * A handle to an object implementing the #GMountIface interface.
 106  **/
 107 typedef struct _GMount                        GMount; /* Dummy typedef */
 108 typedef struct _GMountOperation               GMountOperation;
 109 typedef struct _GNetworkAddress               GNetworkAddress;
 110 typedef struct _GNetworkService               GNetworkService;
 111 typedef struct _GOutputStream                 GOutputStream;
 112 typedef struct _GIOStream                     GIOStream;
 113 typedef struct _GResolver                     GResolver;
 114 typedef struct _GSeekable                     GSeekable;
 115 typedef struct _GSimpleAsyncResult            GSimpleAsyncResult;
 116
 117 /**
 118  * GSocket:
 119  *
 120  * A lowlevel network socket object.
 121  *
 122  * Since: 2.22
 123  **/
 124 typedef struct _GSocket                       GSocket;
 125
 126 /**
 127  * GSocketControlMessage:
 128  *
 129  * Base class for socket-type specific control messages that can be sent and
 130  * received over #GSocket.
 131  **/
 132 typedef struct _GSocketControlMessage         GSocketControlMessage;
 133 /**
 134  * GSocketClient:
 135  *
 136  * A helper class for network clients to make connections.
 137  *
 138  * Since: 2.22
 139  **/
 140 typedef struct _GSocketClient                               GSocketClient;
 141 /**
 142  * GSocketConnection:
 143  *
 144  * A socket connection GIOStream object for connection-oriented sockets.
 145  *
 146  * Since: 2.22
 147  **/
 148 typedef struct _GSocketConnection                           GSocketConnection;
 149 /**
 150  * GSocketClient:
 151  *
 152  * A helper class for network servers to listen for and accept connections.
 153  *
 154  * Since: 2.22
 155  **/
 156 typedef struct _GSocketListener                             GSocketListener;
 157 /**
 158  * GSocketService:
 159  *
 160  * A helper class for handling accepting incomming connections in the
 161  * glib mainloop.
 162  *
 163  * Since: 2.22
 164  **/
 165 typedef struct _GSocketService                              GSocketService;
 166 typedef struct _GSocketAddress                GSocketAddress;
 167 typedef struct _GSocketAddressEnumerator      GSocketAddressEnumerator;
 168 typedef struct _GSocketConnectable            GSocketConnectable;
 169 typedef struct _GSrvTarget                    GSrvTarget;
 170 /**
 171  * GTcpConnection:
 172  *
 173  * A #GSocketConnection for TCP/IP connections.
 174  *
 175  * Since: 2.22
 176  **/
 177 typedef struct _GTcpConnection                              GTcpConnection;
 178 /**
 179  * GThreadedSocketService:
 180  *
 181  * A helper class for handling accepting incomming connections in the
 182  * glib mainloop and handling them in a thread.
 183  *
 184  * Since: 2.22
 185  **/
 186 typedef struct _GThreadedSocketService                      GThreadedSocketService;
 187 typedef struct _GThemedIcon                   GThemedIcon;
 188 typedef struct _GVfs                          GVfs; /* Dummy typedef */
 189
 190 /**
 191  * GVolume:
 192  *
 193  * Opaque mountable volume object.
 194  **/
 195 typedef struct _GVolume                       GVolume; /* Dummy typedef */
 196 typedef struct _GVolumeMonitor                GVolumeMonitor;
 197
 198 /**
 199  * GAsyncReadyCallback:
 200  * @source_object: the object the asynchronous operation was started with.
 201  * @res: a #GAsyncResult.
 202  * @user_data: user data passed to the callback.
 203  *
 204  * Type definition for a function that will be called back when an asynchronous
 205  * operation within GIO has been completed.
 206  **/
 207 typedef void (*GAsyncReadyCallback) (GObject *source_object,
 208                                      GAsyncResult *res,
 209                                      gpointer user_data);
 210
 211 /**
 212  * GFileProgressCallback:
 213  * @current_num_bytes: the current number of bytes in the operation.
 214  * @total_num_bytes: the total number of bytes in the operation.
 215  * @user_data: user data passed to the callback.
 216  *
 217  * When doing file operations that may take a while, such as moving
 218  * a file or copying a file, a progress callback is used to pass how
 219  * far along that operation is to the application.
 220  **/
 221 typedef void (*GFileProgressCallback) (goffset current_num_bytes,
 222                                        goffset total_num_bytes,
 223                                        gpointer user_data);
 224
 225 /**
 226  * GFileReadMoreCallback:
 227  * @file_contents: the data as currently read.
 228  * @file_size: the size of the data currently read.
 229  * @callback_data: data passed to the callback.
 230  *
 231  * When loading the partial contents of a file with g_file_load_partial_contents_async(),
 232  * it may become necessary to determine if any more data from the file should be loaded.
 233  * A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data
 234  * should be read, or %FALSE otherwise.
 235  *
 236  * Returns: %TRUE if more data should be read back. %FALSE otherwise.
 237  **/
 238 typedef gboolean (* GFileReadMoreCallback) (const char *file_contents,
 239                                             goffset file_size,
 240                                             gpointer callback_data);
 241
 242
 243 /**
 244  * GIOSchedulerJobFunc:
 245  * @job: a #GIOSchedulerJob.
 246  * @cancellable: optional #GCancellable object, %NULL to ignore.
 247  * @user_data: the data to pass to callback function
 248  *
 249  * I/O Job function.
 250  *
 251  * Note that depending on whether threads are available, the
 252  * #GIOScheduler may run jobs in separate threads or in an idle
 253  * in the mainloop.
 254  *
 255  * Long-running jobs should periodically check the @cancellable
 256  * to see if they have been cancelled.
 257  *
 258  * Returns: %TRUE if this function should be called again to
 259  *    complete the job, %FALSE if the job is complete (or cancelled)
 260  **/
 261 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
 262                                          GCancellable    *cancellable,
 263                                          gpointer         user_data);
 264
 265 /**
 266  * GSimpleAsyncThreadFunc:
 267  * @res: a #GSimpleAsyncResult.
 268  * @object: a #GObject.
 269  * @cancellable: optional #GCancellable object, %NULL to ignore.
 270  *
 271  * Simple thread function that runs an asynchronous operation and
 272  * checks for cancellation.
 273  **/
 274 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
 275                                         GObject *object,
 276                                         GCancellable *cancellable);
 277
 278 /**
 279  * GSocketSourceFunc:
 280  * @socket: the #GSocket
 281  * @condition: the current condition at the source fired.
 282  * @user_data: data passed in by the user.
 283  *
 284  * This is the function type of the callback used for the #GSource
 285  * returned by g_socket_create_source().
 286  *
 287  * Returns: it should return %FALSE if the source should be removed.
 288  *
 289  * Since: 2.22
 290  */
 291 typedef gboolean (*GSocketSourceFunc) (GSocket *socket,
 292                                        GIOCondition condition,
 293                                        gpointer user_data);
 294
 295 /**
 296  * GInputVector:
 297  * @buffer: Pointer to a buffer where data will be written.
 298  * @size: the available size in @buffer.
 299  *
 300  * Structure used for scatter/gather data input.
 301  * You generally pass in an array of #GInputVector<!-- -->s
 302  * and the operation will store the read data starting in the
 303  * first buffer, switching to the next as needed.
 304  *
 305  * Since: 2.22
 306  */
 307 typedef struct _GInputVector GInputVector;
 308
 309 struct _GInputVector {
 310   gpointer buffer;
 311   gsize size;
 312 };
 313
 314 /**
 315  * GOutputVector:
 316  * @buffer: Pointer to a buffer of data to read.
 317  * @size: the size of @buffer.
 318  *
 319  * Structure used for scatter/gather data output.
 320  * You generally pass in an array of #GOutputVector<!-- -->s
 321  * and the operation will use all the buffers as if they were
 322  * one buffer.
 323  *
 324  * Since: 2.22
 325  */
 326 typedef struct _GOutputVector GOutputVector;
 327
 328 struct _GOutputVector {
 329   gconstpointer buffer;
 330   gsize size;
 331 };
 332
 333
 334 G_END_DECLS
 335
 336 #endif /* __GIO_TYPES_H__ */