glib/giochannel.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_IOCHANNEL_H__
  28 #define __G_IOCHANNEL_H__
  29
  30 #include <glib/gmain.h>
  31 #include <glib/gtypes.h>
  32
  33 G_BEGIN_DECLS
  34
  35 /* GIOChannel
  36  */
  37
  38 typedef struct _GIOChannel      GIOChannel;
  39 typedef struct _GIOFuncs        GIOFuncs;
  40 typedef enum
  41 {
  42   G_IO_ERROR_NONE,
  43   G_IO_ERROR_AGAIN,
  44   G_IO_ERROR_INVAL,
  45   G_IO_ERROR_UNKNOWN
  46 } GIOError;
  47 typedef enum
  48 {
  49   G_SEEK_CUR,
  50   G_SEEK_SET,
  51   G_SEEK_END
  52 } GSeekType;
  53 typedef enum
  54 {
  55   G_IO_IN       GLIB_SYSDEF_POLLIN,
  56   G_IO_OUT      GLIB_SYSDEF_POLLOUT,
  57   G_IO_PRI      GLIB_SYSDEF_POLLPRI,
  58   G_IO_ERR      GLIB_SYSDEF_POLLERR,
  59   G_IO_HUP      GLIB_SYSDEF_POLLHUP,
  60   G_IO_NVAL     GLIB_SYSDEF_POLLNVAL
  61 } GIOCondition;
  62
  63 struct _GIOChannel
  64 {
  65   guint channel_flags;
  66   guint ref_count;
  67   GIOFuncs *funcs;
  68 };
  69
  70 typedef gboolean (*GIOFunc) (GIOChannel   *source,
  71                              GIOCondition  condition,
  72                              gpointer      data);
  73 struct _GIOFuncs
  74 {
  75   GIOError  (*io_read)         (GIOChannel   *channel,
  76                                 gchar        *buf,
  77                                 guint         count,
  78                                 guint        *bytes_read);
  79   GIOError  (*io_write)        (GIOChannel   *channel,
  80                                 gchar        *buf,
  81                                 guint         count,
  82                                 guint        *bytes_written);
  83   GIOError  (*io_seek)         (GIOChannel   *channel,
  84                                 gint          offset,
  85                                 GSeekType     type);
  86   void      (*io_close)        (GIOChannel   *channel);
  87   GSource * (*io_create_watch) (GIOChannel   *channel,
  88                                 GIOCondition  condition);
  89   void      (*io_free)         (GIOChannel   *channel);
  90 };
  91
  92 void        g_io_channel_init   (GIOChannel    *channel);
  93 void        g_io_channel_ref    (GIOChannel    *channel);
  94 void        g_io_channel_unref  (GIOChannel    *channel);
  95 GIOError    g_io_channel_read   (GIOChannel    *channel,
  96                                  gchar         *buf,
  97                                  guint          count,
  98                                  guint         *bytes_read);
  99 GIOError  g_io_channel_write    (GIOChannel    *channel,
 100                                  gchar         *buf,
 101                                  guint          count,
 102                                  guint         *bytes_written);
 103 GIOError  g_io_channel_seek     (GIOChannel    *channel,
 104                                  gint           offset,
 105                                  GSeekType      type);
 106 void      g_io_channel_close    (GIOChannel    *channel);
 107 guint     g_io_add_watch_full   (GIOChannel    *channel,
 108                                  gint           priority,
 109                                  GIOCondition   condition,
 110                                  GIOFunc        func,
 111                                  gpointer       user_data,
 112                                  GDestroyNotify notify);
 113 GSource *g_io_create_watch      (GIOChannel   *channel,
 114                                  GIOCondition  condition);
 115 guint    g_io_add_watch         (GIOChannel    *channel,
 116                                  GIOCondition   condition,
 117                                  GIOFunc        func,
 118                                  gpointer       user_data);
 119
 120 /* On Unix, IO channels created with this function for any file
 121  * descriptor or socket.
 122  *
 123  * On Win32, this can be used either for files opened with the MSVCRT
 124  * (the Microsoft run-time C library) _open() or _pipe, including file
 125  * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
 126  * or for Winsock SOCKETs. If the parameter is a legal file
 127  * descriptor, it is assumed to be such, otherwise it should be a
 128  * SOCKET. This relies on SOCKETs and file descriptors not
 129  * overlapping. If you want to be certain, call either
 130  * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
 131  * instead as appropriate.
 132  *
 133  * The term file descriptor as used in the context of Win32 refers to
 134  * the emulated Unix-like file descriptors MSVCRT provides. The native
 135  * corresponding concept is file HANDLE. There isn't as of yet a way to
 136  * get GIOChannels for Win32 file HANDLEs.
 137  */
 138 GIOChannel* g_io_channel_unix_new    (int         fd);
 139 gint        g_io_channel_unix_get_fd (GIOChannel *channel);
 140
 141 #ifdef G_OS_WIN32
 142
 143 #define G_WIN32_MSG_HANDLE 19981206
 144
 145 /* Use this to get a GPollFD from a GIOChannel, so that you can call
 146  * g_io_channel_win32_poll(). After calling this you should only use
 147  * g_io_channel_read() to read from the GIOChannel, i.e. never read()
 148  * from the underlying file descriptor. For SOCKETs, it is possible to call
 149  * recv().
 150  */
 151 void        g_io_channel_win32_make_pollfd (GIOChannel   *channel,
 152                                             GIOCondition  condition,
 153                                             GPollFD      *fd);
 154
 155 /* This can be used to wait a until at least one of the channels is readable.
 156  * On Unix you would do a select() on the file descriptors of the channels.
 157  */
 158 gint        g_io_channel_win32_poll   (GPollFD    *fds,
 159                                        gint        n_fds,
 160                                        gint        timeout);
 161
 162 /* This is used to add polling for Windows messages. GDK (GTk+) programs
 163  * should *not* use this.
 164  */
 165 void        g_main_poll_win32_msg_add (gint        priority,
 166                                        GPollFD    *fd,
 167                                        guint       hwnd);
 168
 169 /* Create an IO channel for Windows messages for window handle hwnd. */
 170 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
 171
 172 /* Create an IO channel for C runtime (emulated Unix-like) file
 173  * descriptors. After calling g_io_add_watch() on a IO channel
 174  * returned by this function, you shouldn't call read() on the file
 175  * descriptor. This is because adding polling for a file descriptor is
 176  * implemented on Win32 by starting a thread that sits blocked in a
 177  * read() from the file descriptor most of the time. All reads from
 178  * the file descriptor should be done by this internal GLib
 179  * thread. Your code should call only g_io_channel_read().
 180  */
 181 GIOChannel* g_io_channel_win32_new_fd (int         fd);
 182
 183 /* Get the C runtime file descriptor of a channel. */
 184 gint        g_io_channel_win32_get_fd (GIOChannel *channel);
 185
 186 /* Create an IO channel for a winsock socket. The parameter should be
 187  * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
 188  * you can use normal recv() or recvfrom() on sockets even if GLib
 189  * is polling them.
 190  */
 191 GIOChannel *g_io_channel_win32_new_socket (gint socket);
 192
 193 #endif
 194
 195 G_END_DECLS
 196
 197 #endif /* __G_IOCHANNEL_H__ */