/usr/include/giomm-2.4/giomm/pollableinputstream.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_POLLABLEINPUTSTREAM_H
#define _GIOMM_POLLABLEINPUTSTREAM_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2012 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/interface.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GPollableInputStreamInterface GPollableInputStreamInterface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GPollableInputStream GPollableInputStream;
typedef struct _GPollableInputStreamClass GPollableInputStreamClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class PollableInputStream_Class; } // namespace Gio
namespace Gio
{
class Cancellable;
//TODO: Instead derive from InputStream, when we can break ABI,
//because the GPollableInputStream interface requires the GInputStream interface.
//LoadableIcon does a similar thing correctly, for instance.
/** PollableInputStream - Interface for pollable input streams.
* PollableInputStream is implemented by InputStreams that can be polled for
* readiness to read. This can be used when interfacing with a non-GIO API that
* expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
* @newin{2,34}
*/
class PollableInputStream : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef PollableInputStream CppObjectType;
typedef PollableInputStream_Class CppClassType;
typedef GPollableInputStream BaseObjectType;
typedef GPollableInputStreamInterface BaseClassType;
private:
friend class PollableInputStream_Class;
static CppClassType pollableinputstream_class_;
// noncopyable
PollableInputStream(const PollableInputStream&);
PollableInputStream& operator=(const PollableInputStream&);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
PollableInputStream();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit PollableInputStream(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit PollableInputStream(GPollableInputStream* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~PollableInputStream();
static void add_interface(GType gtype_implementer);
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GPollableInputStream* gobj() { return reinterpret_cast<GPollableInputStream*>(gobject_); }
///Provides access to the underlying C GObject.
const GPollableInputStream* gobj() const { return reinterpret_cast<GPollableInputStream*>(gobject_); }
private:
public:
/** Checks if @a stream is actually pollable. Some classes may implement
* PollableInputStream but have only certain instances of that class
* be pollable. If this method returns <tt>false</tt>, then the behavior of
* other PollableInputStream methods is undefined.
*
* For any given stream, the value returned by this method is constant;
* a stream cannot switch from pollable to non-pollable or vice versa.
*
* @newin{2,28}
*
* @return <tt>true</tt> if @a stream is pollable, <tt>false</tt> if not.
*/
bool can_poll() const;
/** Checks if @a stream can be read.
*
* Note that some stream types may not be able to implement this 100%
* reliably, and it is possible that a call to g_input_stream_read()
* after this returns <tt>true</tt> would still block. To guarantee
* non-blocking behavior, you should always use
* g_pollable_input_stream_read_nonblocking(), which will return a
* IO_ERROR_WOULD_BLOCK error rather than blocking.
*
* @newin{2,28}
*
* @return <tt>true</tt> if @a stream is readable, <tt>false</tt> if not. If an error
* has occurred on @a stream, this will result in
* g_pollable_input_stream_is_readable() returning <tt>true</tt>, and the
* next attempt to read will return the error.
*/
bool is_readable() const;
//TODO: _WRAP_METHOD(Glib::RefPtr<Source> create_source(const Glib::RefPtr<Cancellable>& cancellable), g_pollable_input_stream_create_source)
/** Attempts to read up to @a count bytes from @a stream into @a buffer, as
* with g_input_stream_read(). If @a stream is not currently readable,
* this will immediately return IO_ERROR_WOULD_BLOCK, and you can
* use g_pollable_input_stream_create_source() to create a Source
* that will be triggered when @a stream is readable.
*
* Note that since this method never blocks, you cannot actually
* use @a cancellable to cancel it. However, it will return an error
* if @a cancellable has already been cancelled when you call, which
* may happen if you call this method after a source triggers due
* to having been cancelled.
*
* Virtual: read_nonblocking
*
* @param buffer A buffer to
* read data into (which should be at least @a count bytes long).
* @param count The number of bytes you want to read.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return The number of bytes read, or -1 on error (including
* IO_ERROR_WOULD_BLOCK).
*/
gssize read_nonblocking(void* buffer, gsize count, const Glib::RefPtr<Cancellable>& cancellable);
/// A read_nonblocking() convenience overload.
gssize read_nonblocking(void* buffer, gsize count);
virtual bool can_poll_vfunc() const;
virtual bool is_readable_vfunc() const;
//TODO: _WRAP_VFUNC(Glib::RefPtr<Source> create_source(const Glib::RefPtr<Cancellable>& cancellable), "create_source")
/// @throws Glib::Error.
virtual gssize read_nonblocking_vfunc(void* buffer, gsize count);
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::PollableInputStream
*/
Glib::RefPtr<Gio::PollableInputStream> wrap(GPollableInputStream* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_POLLABLEINPUTSTREAM_H */
|