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