glib-2.0/gio/gpollableinputstream.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2010 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  */
0020
0021 #ifndef __G_POLLABLE_INPUT_STREAM_H__
0022 #define __G_POLLABLE_INPUT_STREAM_H__
0023
0024 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0025 #error "Only <gio/gio.h> can be included directly."
0026 #endif
0027
0028 #include <gio/gio.h>
0029
0030 G_BEGIN_DECLS
0031
0032 #define G_TYPE_POLLABLE_INPUT_STREAM               (g_pollable_input_stream_get_type ())
0033 #define G_POLLABLE_INPUT_STREAM(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStream))
0034 #define G_IS_POLLABLE_INPUT_STREAM(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_INPUT_STREAM))
0035 #define G_POLLABLE_INPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStreamInterface))
0036
0037 typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface;
0038
0039 /**
0040  * GPollableInputStreamInterface:
0041  * @g_iface: The parent interface.
0042  * @can_poll: Checks if the #GPollableInputStream instance is actually pollable
0043  * @is_readable: Checks if the stream is readable
0044  * @create_source: Creates a #GSource to poll the stream
0045  * @read_nonblocking: Does a non-blocking read or returns
0046  *   %G_IO_ERROR_WOULD_BLOCK
0047  *
0048  * The interface for pollable input streams.
0049  *
0050  * The default implementation of @can_poll always returns %TRUE.
0051  *
0052  * The default implementation of @read_nonblocking calls
0053  * g_pollable_input_stream_is_readable(), and then calls
0054  * g_input_stream_read() if it returns %TRUE. This means you only need
0055  * to override it if it is possible that your @is_readable
0056  * implementation may return %TRUE when the stream is not actually
0057  * readable.
0058  *
0059  * Since: 2.28
0060  */
0061 struct _GPollableInputStreamInterface
0062 {
0063   GTypeInterface g_iface;
0064
0065   /* Virtual Table */
0066   gboolean     (*can_poll)         (GPollableInputStream  *stream);
0067
0068   gboolean     (*is_readable)      (GPollableInputStream  *stream);
0069   GSource *    (*create_source)    (GPollableInputStream  *stream,
0070                     GCancellable          *cancellable);
0071   gssize       (*read_nonblocking) (GPollableInputStream  *stream,
0072                     void                  *buffer,
0073                     gsize                  count,
0074                     GError               **error);
0075 };
0076
0077 GIO_AVAILABLE_IN_ALL
0078 GType    g_pollable_input_stream_get_type         (void) G_GNUC_CONST;
0079
0080 GIO_AVAILABLE_IN_ALL
0081 gboolean g_pollable_input_stream_can_poll         (GPollableInputStream  *stream);
0082
0083 GIO_AVAILABLE_IN_ALL
0084 gboolean g_pollable_input_stream_is_readable      (GPollableInputStream  *stream);
0085 GIO_AVAILABLE_IN_ALL
0086 GSource *g_pollable_input_stream_create_source    (GPollableInputStream  *stream,
0087                            GCancellable          *cancellable);
0088
0089 GIO_AVAILABLE_IN_ALL
0090 gssize   g_pollable_input_stream_read_nonblocking (GPollableInputStream  *stream,
0091                            void                  *buffer,
0092                            gsize                  count,
0093                            GCancellable          *cancellable,
0094                            GError               **error);
0095
0096 G_END_DECLS
0097
0098
0099 #endif /* __G_POLLABLE_INPUT_STREAM_H__ */