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