1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #ifndef __G_IOCHANNEL_H__
28 #define __G_IOCHANNEL_H__
38 typedef struct _GIOChannel GIOChannel
;
39 typedef struct _GIOFuncs GIOFuncs
;
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
70 typedef gboolean (*GIOFunc
) (GIOChannel
*source
,
71 GIOCondition condition
,
75 GIOError (*io_read
) (GIOChannel
*channel
,
79 GIOError (*io_write
) (GIOChannel
*channel
,
82 guint
*bytes_written
);
83 GIOError (*io_seek
) (GIOChannel
*channel
,
86 void (*io_close
) (GIOChannel
*channel
);
87 GSource
* (*io_create_watch
) (GIOChannel
*channel
,
88 GIOCondition condition
);
89 void (*io_free
) (GIOChannel
*channel
);
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
,
99 GIOError
g_io_channel_write (GIOChannel
*channel
,
102 guint
*bytes_written
);
103 GIOError
g_io_channel_seek (GIOChannel
*channel
,
106 void g_io_channel_close (GIOChannel
*channel
);
107 guint
g_io_add_watch_full (GIOChannel
*channel
,
109 GIOCondition condition
,
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
,
120 /* On Unix, IO channels created with this function for any file
121 * descriptor or socket.
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.
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.
138 GIOChannel
* g_io_channel_unix_new (int fd
);
139 gint
g_io_channel_unix_get_fd (GIOChannel
*channel
);
143 #define G_WIN32_MSG_HANDLE 19981206
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
151 void g_io_channel_win32_make_pollfd (GIOChannel
*channel
,
152 GIOCondition condition
,
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.
158 gint
g_io_channel_win32_poll (GPollFD
*fds
,
162 /* This is used to add polling for Windows messages. GDK (GTk+) programs
163 * should *not* use this.
165 void g_main_poll_win32_msg_add (gint priority
,
169 /* Create an IO channel for Windows messages for window handle hwnd. */
170 GIOChannel
*g_io_channel_win32_new_messages (guint hwnd
);
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().
181 GIOChannel
* g_io_channel_win32_new_fd (int fd
);
183 /* Get the C runtime file descriptor of a channel. */
184 gint
g_io_channel_win32_get_fd (GIOChannel
*channel
);
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
191 GIOChannel
*g_io_channel_win32_new_socket (gint socket
);
197 #endif /* __G_IOCHANNEL_H__ */