/usr/include/giomm-2.4/giomm/unixconnection.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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_UNIXCONNECTION_H
#define _GIOMM_UNIXCONNECTION_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2010 Jonathon Jongsma
*
* 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/object.h>
#include <giomm/socketconnection.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GUnixConnection GUnixConnection;
typedef struct _GUnixConnectionClass GUnixConnectionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class UnixConnection_Class; } // namespace Gio
namespace Gio
{
/**
* A Unix domain SocketConnection
*
* This is the subclass of SocketConnection that is created
* for UNIX domain sockets.
*
* It contains functions to do some of the unix socket specific
* functionallity like passing file descriptors.
*
* @newin{2,24}
* @ingroup NetworkIO
*/
class UnixConnection : public Gio::SocketConnection
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef UnixConnection CppObjectType;
typedef UnixConnection_Class CppClassType;
typedef GUnixConnection BaseObjectType;
typedef GUnixConnectionClass BaseClassType;
private: friend class UnixConnection_Class;
static CppClassType unixconnection_class_;
private:
// noncopyable
UnixConnection(const UnixConnection&);
UnixConnection& operator=(const UnixConnection&);
protected:
explicit UnixConnection(const Glib::ConstructParams& construct_params);
explicit UnixConnection(GUnixConnection* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~UnixConnection();
/** 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.
GUnixConnection* gobj() { return reinterpret_cast<GUnixConnection*>(gobject_); }
///Provides access to the underlying C GObject.
const GUnixConnection* gobj() const { return reinterpret_cast<GUnixConnection*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GUnixConnection* gobj_copy();
private:
//This is not available on Win32.
//This source file will not be compiled on Win32,
//and no class defined in it will be registered by wrap_init().
public:
/** Passes a file descriptor to the receiving side of the
* connection. The receiving end has to call g_unix_connection_receive_fd()
* to accept the file descriptor.
*
* As well as sending the fd this also writes a single byte to the
* stream, as this is required for fd passing to work on some
* implementations.
*
* @newin{2,22}
*
* @param fd A file descriptor.
* @param cancellable Optional Cancellable object, <tt>0</tt> to ignore.
* @return A <tt>true</tt> on success, <tt>0</tt> on error.
*/
bool send_fd(int fd, const Glib::RefPtr<Cancellable>& cancellable);
/// A send_fd() convenience overload.
bool send_fd(int fd);
/** Receives a file descriptor from the sending end of the connection.
* The sending end has to call g_unix_connection_send_fd() for this
* to work.
*
* As well as reading the fd this also reads a single byte from the
* stream, as this is required for fd passing to work on some
* implementations.
*
* @newin{2,22}
*
* @param cancellable Optional Cancellable object, <tt>0</tt> to ignore.
* @return A file descriptor on success, -1 on error.
*/
int receive_fd(const Glib::RefPtr<Cancellable>& cancellable);
/// A receive_fd() convenience overload.
int receive_fd();
/** Receives credentials from the sending end of the connection. The
* sending end has to call g_unix_connection_send_credentials() (or
* similar) for this to work.
*
* As well as reading the credentials this also reads (and discards) a
* single byte from the stream, as this is required for credentials
* passing to work on some implementations.
*
* Other ways to exchange credentials with a foreign peer includes the
* UnixCredentialsMessage type and g_socket_get_credentials() function.
*
* @newin{2,26}
*
* @param cancellable A Cancellable or <tt>0</tt>.
* @return Received credentials on success (free with
* Glib::object_unref()), <tt>0</tt> if @a error is set.
*/
Glib::RefPtr<Credentials> receive_credentials(const Glib::RefPtr<Cancellable>& cancellable);
/// A receive_credentials() convenience overload.
Glib::RefPtr<Credentials> receive_credentials();
/** Receives credentials from the sending end of the connection. The
* sending end has to call g_unix_connection_send_credentials() (or
* similar) for this to work.
*
* As well as reading the credentials this also reads (and discards) a
* single byte from the stream, as this is required for credentials
* passing to work on some implementations.
*
* Other ways to exchange credentials with a foreign peer includes the
* UnixCredentialsMessage type and g_socket_get_credentials() function.
*
* @newin{2,26}
*
* @param cancellable A Cancellable or <tt>0</tt>.
* @return Received credentials on success (free with
* Glib::object_unref()), <tt>0</tt> if @a error is set.
*/
Glib::RefPtr<const Credentials> receive_credentials(const Glib::RefPtr<Cancellable>& cancellable) const;
/// A receive_credentials() convenience overload.
Glib::RefPtr<const Credentials> receive_credentials() const;
/** Asynchronously receive credentials.
* For more details, see receive_credentials() which is the synchronous
* version of this call.
*
* When the operation is finished, @a slot will be called. You can then call
* receive_credentials_finish() to get the result of the operation.
*
* @param slot A SlotAsyncReady to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @newin{2,36}
*/
void receive_credentials_async(const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable version of receive_credentials_async().
void receive_credentials_async(const SlotAsyncReady& slot);
/** Finishes an asynchronous receive credentials operation started with
* g_unix_connection_receive_credentials_async().
*
* @newin{2,32}
*
* @param result A AsyncResult.
* @return A Credentials, or <tt>0</tt> on error.
* Free the returned object with Glib::object_unref().
*/
Glib::RefPtr<Credentials> receive_credentials_finish(const Glib::RefPtr<AsyncResult>& result);
/** Passes the credentials of the current user the receiving side
* of the connection. The receiving end has to call
* g_unix_connection_receive_credentials() (or similar) to accept the
* credentials.
*
* As well as sending the credentials this also writes a single NUL
* byte to the stream, as this is required for credentials passing to
* work on some implementations.
*
* Other ways to exchange credentials with a foreign peer includes the
* UnixCredentialsMessage type and g_socket_get_credentials() function.
*
* @newin{2,26}
*
* @param cancellable A Cancellable or <tt>0</tt>.
* @return <tt>true</tt> on success, <tt>false</tt> if @a error is set.
*/
bool send_credentials(const Glib::RefPtr<Cancellable>& cancellable);
/// A send_credentials() convenience overload.
bool send_credentials();
/** Asynchronously send credentials.
* For more details, see send_credentials() which is the synchronous version
* of this call.
*
* When the operation is finished, @a slot will be called. You can then call
* send_credentials_finish() to get the result of the operation.
*
* @param slot A SlotAsyncReady to call when the request is satisfied.
* @param cancellable A Cancellable object.
* @newin{2,36}
*/
void send_credentials_async(const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable version of send_credentials_async().
void send_credentials_async(const SlotAsyncReady& slot);
/** Finishes an asynchronous send credentials operation started with
* g_unix_connection_send_credentials_async().
*
* @newin{2,32}
*
* @param result A AsyncResult.
* @return <tt>true</tt> if the operation was successful, otherwise <tt>false</tt>.
*/
bool send_credentials_finish(const Glib::RefPtr<AsyncResult>& result);
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::UnixConnection
*/
Glib::RefPtr<Gio::UnixConnection> wrap(GUnixConnection* object, bool take_copy = false);
}
#endif /* _GIOMM_UNIXCONNECTION_H */
|