gio/gpollableinputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2010 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef __G_POLLABLE_INPUT_STREAM_H__
  22 #define __G_POLLABLE_INPUT_STREAM_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/gio.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_POLLABLE_INPUT_STREAM               (g_pollable_input_stream_get_type ())
  33 #define G_POLLABLE_INPUT_STREAM(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStream))
  34 #define G_IS_POLLABLE_INPUT_STREAM(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_POLLABLE_INPUT_STREAM))
  35 #define G_POLLABLE_INPUT_STREAM_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_POLLABLE_INPUT_STREAM, GPollableInputStreamInterface))
  36
  37 /**
  38  * GPollableInputStream:
  39  *
  40  * An interface for a #GInputStream that can be polled for readability.
  41  *
  42  * Since: 2.28
  43  */
  44 typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface;
  45
  46 /**
  47  * GPollableInputStreamInterface:
  48  * @g_iface: The parent interface.
  49  * @can_poll: Checks if the #GPollableInputStream instance is actually pollable
  50  * @is_readable: Checks if the stream is readable
  51  * @create_source: Creates a #GSource to poll the stream
  52  * @read_nonblocking: Does a non-blocking read or returns
  53  *   %G_IO_ERROR_WOULD_BLOCK
  54  *
  55  * The interface for pollable input streams.
  56  *
  57  * The default implementation of @can_poll always returns %TRUE.
  58  *
  59  * The default implementation of @read_nonblocking calls
  60  * g_pollable_input_stream_is_readable(), and then calls
  61  * g_input_stream_read() if it returns %TRUE. This means you only need
  62  * to override it if it is possible that your @is_readable
  63  * implementation may return %TRUE when the stream is not actually
  64  * readable.
  65  *
  66  * Since: 2.28
  67  */
  68 struct _GPollableInputStreamInterface
  69 {
  70   GTypeInterface g_iface;
  71
  72   /* Virtual Table */
  73   gboolean     (*can_poll)         (GPollableInputStream  *stream);
  74
  75   gboolean     (*is_readable)      (GPollableInputStream  *stream);
  76   GSource *    (*create_source)    (GPollableInputStream  *stream,
  77                                     GCancellable          *cancellable);
  78   gssize       (*read_nonblocking) (GPollableInputStream  *stream,
  79                                     void                  *buffer,
  80                                     gsize                  count,
  81                                     GError               **error);
  82 };
  83
  84 GIO_AVAILABLE_IN_ALL
  85 GType    g_pollable_input_stream_get_type         (void) G_GNUC_CONST;
  86
  87 GIO_AVAILABLE_IN_ALL
  88 gboolean g_pollable_input_stream_can_poll         (GPollableInputStream  *stream);
  89
  90 GIO_AVAILABLE_IN_ALL
  91 gboolean g_pollable_input_stream_is_readable      (GPollableInputStream  *stream);
  92 GIO_AVAILABLE_IN_ALL
  93 GSource *g_pollable_input_stream_create_source    (GPollableInputStream  *stream,
  94                                                    GCancellable          *cancellable);
  95
  96 GIO_AVAILABLE_IN_ALL
  97 gssize   g_pollable_input_stream_read_nonblocking (GPollableInputStream  *stream,
  98                                                    void                  *buffer,
  99                                                    gsize                  count,
 100                                                    GCancellable          *cancellable,
 101                                                    GError               **error);
 102
 103 G_END_DECLS
 104
 105
 106 #endif /* __G_POLLABLE_INPUT_STREAM_H__ */