glibmm: Gio::UnixConnection Class Reference

#include <giomm/unixconnection.h>

Inheritance diagram for Gio::UnixConnection:

[legend]

Public Member Functions
	UnixConnection (UnixConnection &&src) noexcept

UnixConnection &	operator= (UnixConnection &&src) noexcept

	~UnixConnection () noexcept override

GUnixConnection *	gobj ()
	Provides access to the underlying C GObject.

const GUnixConnection *	gobj () const
	Provides access to the underlying C GObject.

GUnixConnection *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool	send_fd (int fd, const Glib::RefPtr< Cancellable > &cancellable)
	Passes a file descriptor to the receiving side of the connection.

bool	send_fd (int fd)
	A send_fd() convenience overload.

int	receive_fd (const Glib::RefPtr< Cancellable > &cancellable)
	Receives a file descriptor from the sending end of the connection.

int	receive_fd ()
	A receive_fd() convenience overload.

Glib::RefPtr< Credentials >	receive_credentials (const Glib::RefPtr< Cancellable > &cancellable)
	Receives credentials from the sending end of the connection.

Glib::RefPtr< Credentials >	receive_credentials ()
	A receive_credentials() convenience overload.

Glib::RefPtr< const Credentials >	receive_credentials (const Glib::RefPtr< Cancellable > &cancellable) const
	Receives credentials from the sending end of the connection.

Glib::RefPtr< const Credentials >	receive_credentials () const
	A receive_credentials() convenience overload.

void	receive_credentials_async (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable)
	Asynchronously receive credentials.

void	receive_credentials_async (const SlotAsyncReady &slot)
	A non-cancellable version of receive_credentials_async().

Glib::RefPtr< Credentials >	receive_credentials_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async().

bool	send_credentials (const Glib::RefPtr< Cancellable > &cancellable)
	Passes the credentials of the current user the receiving side of the connection.

bool	send_credentials ()
	A send_credentials() convenience overload.

void	send_credentials_async (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable)
	Asynchronously send credentials.

void	send_credentials_async (const SlotAsyncReady &slot)
	A non-cancellable version of send_credentials_async().

bool	send_credentials_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async().

Public Member Functions inherited from Gio::SocketConnection
	SocketConnection (SocketConnection &&src) noexcept

SocketConnection &	operator= (SocketConnection &&src) noexcept

	~SocketConnection () noexcept override

GSocketConnection *	gobj ()
	Provides access to the underlying C GObject.

const GSocketConnection *	gobj () const
	Provides access to the underlying C GObject.

GSocketConnection *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool	connect (const Glib::RefPtr< SocketAddress > &address, const Glib::RefPtr< Cancellable > &cancellable)
	Connect connection to the specified remote address.

bool	connect (const Glib::RefPtr< SocketAddress > &address)
	A connect() convenience overload.

void	connect_async (const Glib::RefPtr< SocketAddress > &address, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable)
	Asynchronously connect this connection to the specified remote address.

void	connect_async (const Glib::RefPtr< SocketAddress > &address, const SlotAsyncReady &slot)
	A non-cancellable version of connect_async().

bool	connect_finish (const Glib::RefPtr< AsyncResult > &result)
	Gets the result of a g_socket_connection_connect_async() call.

bool	is_connected () const
	Checks if connection is connected.

Glib::RefPtr< Socket >	get_socket ()
	Gets the underlying Socket object of the connection.

Glib::RefPtr< const Socket >	get_socket () const
	Gets the underlying Socket object of the connection.

Glib::RefPtr< SocketAddress >	get_local_address ()
	Try to get the local address of a socket connection.

Glib::RefPtr< const SocketAddress >	get_local_address () const
	Try to get the local address of a socket connection.

Glib::RefPtr< SocketAddress >	get_remote_address ()
	Try to get the remote address of a socket connection.

Glib::RefPtr< const SocketAddress >	get_remote_address () const
	Try to get the remote address of a socket connection.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Socket > >	property_socket () const
	The underlying Gio::Socket.

Public Member Functions inherited from Gio::IOStream
	IOStream (IOStream &&src) noexcept

IOStream &	operator= (IOStream &&src) noexcept

	~IOStream () noexcept override

GIOStream *	gobj ()
	Provides access to the underlying C GObject.

const GIOStream *	gobj () const
	Provides access to the underlying C GObject.

GIOStream *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void	splice_async (const Glib::RefPtr< IOStream > &stream2, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Asyncronously splice the output stream to the input stream of stream2, and splice the output stream of stream2 to the input stream of this stream.

void	splice_async (const Glib::RefPtr< IOStream > &stream2, const SlotAsyncReady &slot, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	A non-cancellable version of splice_async().

Glib::RefPtr< InputStream >	get_input_stream ()
	Gets the input stream for this object.

Glib::RefPtr< OutputStream >	get_output_stream ()
	Gets the output stream for this object.

bool	close (const Glib::RefPtr< Cancellable > &cancellable)
	Closes the stream, releasing resources related to it.

bool	close ()
	A close() convenience overload.

void	close_async (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)

void	close_async (const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)

bool	close_finish (const Glib::RefPtr< AsyncResult > &result)
	Closes a stream.

bool	is_closed () const
	Checks if a stream is closed.

bool	has_pending () const
	Checks if a stream has pending actions.

bool	set_pending ()
	Sets stream to have actions pending.

void	clear_pending ()
	Clears the pending flag on stream.

Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete

Object &	operator= (const Object &)=delete

	Object (Object &&src) noexcept

Object &	operator= (Object &&src) noexcept

void *	get_data (const QueryQuark & key)

void	set_data (const Quark & key, void *data)

void	set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)

void	set_data (const Quark & key, void *data, DestroyNotify notify)
	Prefer set_data_with_c_callback() with a callback with C linkage.

void	remove_data (const QueryQuark &quark)

void *	steal_data (const QueryQuark &quark)

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.

void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.

void	freeze_notify ()
	Increases the freeze count on object.

void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().

virtual void	reference () const
	Increment the reference count for this object.

virtual void	unreference () const
	Decrement the reference count for this object.

GObject *	gobj ()
	Provides access to the underlying C GObject.

const GObject *	gobj () const
	Provides access to the underlying C GObject.

GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Static Public Member Functions inherited from Gio::SocketConnection
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< SocketConnection >	create (const Glib::RefPtr< Socket > &socket)
	Creates a SocketConnection subclass of the right type for socket.

Static Public Member Functions inherited from Gio::IOStream
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static bool	splice_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes an asynchronous io stream splice operation.

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::UnixConnection >	wrap (GUnixConnection *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gio::SocketConnection
Glib::RefPtr< Gio::SocketConnection >	wrap (GSocketConnection *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gio::IOStream
Glib::RefPtr< Gio::IOStream >	wrap (GIOStream *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)

Additional Inherited Members
Public Types inherited from Gio::IOStream
enum class	SpliceFlags { NONE = 0x0 , CLOSE_STREAM1 = (1 << 0) , CLOSE_STREAM2 = (1 << 1) , WAIT_FOR_BOTH = (1 << 2) }

Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)

Protected Member Functions inherited from Glib::Object
	Object ()

	Object (const Glib::ConstructParams &construct_params)

	Object (GObject *castitem)

	~Object () noexcept override

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.

	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.

	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Detailed Description

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.

Since glibmm 2.24:

Constructor & Destructor Documentation

◆ UnixConnection()

Gio::UnixConnection::UnixConnection ( UnixConnection && src )

noexcept

◆ ~UnixConnection()

Gio::UnixConnection::~UnixConnection ( )

overridenoexcept

Member Function Documentation

◆ get_type()

static GType Gio::UnixConnection::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GUnixConnection * Gio::UnixConnection::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GUnixConnection * Gio::UnixConnection::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GUnixConnection * Gio::UnixConnection::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

UnixConnection & Gio::UnixConnection::operator= ( UnixConnection && src )

noexcept

◆ receive_credentials() [1/4]

Glib::RefPtr< Credentials > Gio::UnixConnection::receive_credentials ( )

A receive_credentials() convenience overload.

◆ receive_credentials() [2/4]

Glib::RefPtr< const Credentials > Gio::UnixConnection::receive_credentials ( ) const

A receive_credentials() convenience overload.

◆ receive_credentials() [3/4]

Glib::RefPtr< Credentials > Gio::UnixConnection::receive_credentials ( const Glib::RefPtr< Cancellable > & cancellable )

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.

This method can be expected to be available on the following platforms:

Linux since GLib 2.26
FreeBSD since GLib 2.26
GNU/kFreeBSD since GLib 2.36
Solaris, Illumos and OpenSolaris since GLib 2.40
GNU/Hurd since GLib 2.40

Other ways to exchange credentials with a foreign peer includes the UnixCredentialsMessage type and g_socket_get_credentials() function.

Since glibmm 2.26:

Parameters

cancellable A Cancellable or nullptr.

Returns: Received credentials on success (free with Glib::object_unref()), nullptr if error is set.

Exceptions

Glib::Error

◆ receive_credentials() [4/4]

Glib::RefPtr< const Credentials > Gio::UnixConnection::receive_credentials ( const Glib::RefPtr< Cancellable > & cancellable ) const

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.

This method can be expected to be available on the following platforms:

Linux since GLib 2.26
FreeBSD since GLib 2.26
GNU/kFreeBSD since GLib 2.36
Solaris, Illumos and OpenSolaris since GLib 2.40
GNU/Hurd since GLib 2.40

Other ways to exchange credentials with a foreign peer includes the UnixCredentialsMessage type and g_socket_get_credentials() function.

Since glibmm 2.26:

Parameters

cancellable A Cancellable or nullptr.

Returns: Received credentials on success (free with Glib::object_unref()), nullptr if error is set.

Exceptions

Glib::Error

◆ receive_credentials_async() [1/2]

void Gio::UnixConnection::receive_credentials_async ( const SlotAsyncReady & slot )

A non-cancellable version of receive_credentials_async().

◆ receive_credentials_async() [2/2]

void Gio::UnixConnection::receive_credentials_async	(	const SlotAsyncReady &	slot,
		const Glib::RefPtr< Cancellable > &	cancellable
	)

Asynchronously receive credentials.

For more details, see receive_credentials() which is the synchronous version of this call.

When the operation is finished, slot will be called. You can then call receive_credentials_finish() to get the result of the operation.

Parameters

slot	A SlotAsyncReady to call when the request is satisfied.
cancellable	A Cancellable object.

Since glibmm 2.36:

◆ receive_credentials_finish()

Glib::RefPtr< Credentials > Gio::UnixConnection::receive_credentials_finish ( const Glib::RefPtr< AsyncResult > & result )

Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async().

Since glibmm 2.32:

Parameters

result A AsyncResult.

Returns: A Credentials, or nullptr on error. Free the returned object with Glib::object_unref().

Exceptions

Glib::Error

◆ receive_fd() [1/2]

int Gio::UnixConnection::receive_fd ( )

A receive_fd() convenience overload.

◆ receive_fd() [2/2]

int Gio::UnixConnection::receive_fd ( const Glib::RefPtr< Cancellable > & cancellable )

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.

Since glibmm 2.22:

Parameters

cancellable Optional Cancellable object, nullptr to ignore.

Returns: A file descriptor on success, -1 on error.

Exceptions

Glib::Error

◆ send_credentials() [1/2]

bool Gio::UnixConnection::send_credentials ( )

A send_credentials() convenience overload.

◆ send_credentials() [2/2]

bool Gio::UnixConnection::send_credentials ( const Glib::RefPtr< Cancellable > & cancellable )

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.

This method can be expected to be available on the following platforms:

Linux since GLib 2.26
FreeBSD since GLib 2.26
GNU/kFreeBSD since GLib 2.36
Solaris, Illumos and OpenSolaris since GLib 2.40
GNU/Hurd since GLib 2.40

Other ways to exchange credentials with a foreign peer includes the UnixCredentialsMessage type and g_socket_get_credentials() function.

Since glibmm 2.26:

Parameters

cancellable A Cancellable or nullptr.

Returns: true on success, false if error is set.

Exceptions

Glib::Error

◆ send_credentials_async() [1/2]

void Gio::UnixConnection::send_credentials_async ( const SlotAsyncReady & slot )

A non-cancellable version of send_credentials_async().

◆ send_credentials_async() [2/2]

void Gio::UnixConnection::send_credentials_async	(	const SlotAsyncReady &	slot,
		const Glib::RefPtr< Cancellable > &	cancellable
	)

Asynchronously send credentials.

For more details, see send_credentials() which is the synchronous version of this call.

When the operation is finished, slot will be called. You can then call send_credentials_finish() to get the result of the operation.

Parameters

slot	A SlotAsyncReady to call when the request is satisfied.
cancellable	A Cancellable object.

Since glibmm 2.36:

◆ send_credentials_finish()

bool Gio::UnixConnection::send_credentials_finish ( const Glib::RefPtr< AsyncResult > & result )

Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async().

Since glibmm 2.32:

Parameters

result A AsyncResult.

Returns: true if the operation was successful, otherwise false.

Exceptions

Glib::Error

◆ send_fd() [1/2]

bool Gio::UnixConnection::send_fd ( int fd )

A send_fd() convenience overload.

◆ send_fd() [2/2]

bool Gio::UnixConnection::send_fd	(	int	fd,
		const Glib::RefPtr< Cancellable > &	cancellable
	)

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.

Since glibmm 2.22:

Parameters

fd	A file descriptor.
cancellable	Optional Cancellable object, `nullptr` to ignore.

Returns: A true on success, nullptr on error.

Exceptions

Glib::Error

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gio::UnixConnection > wrap	(	GUnixConnection *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Related Symbols

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnixConnection()

◆ ~UnixConnection()

Member Function Documentation

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ receive_credentials() [1/4]

◆ receive_credentials() [2/4]

◆ receive_credentials() [3/4]

◆ receive_credentials() [4/4]

◆ receive_credentials_async() [1/2]

◆ receive_credentials_async() [2/2]

◆ receive_credentials_finish()

◆ receive_fd() [1/2]

◆ receive_fd() [2/2]

◆ send_credentials() [1/2]

◆ send_credentials() [2/2]

◆ send_credentials_async() [1/2]

◆ send_credentials_async() [2/2]

◆ send_credentials_finish()

◆ send_fd() [1/2]

◆ send_fd() [2/2]

Friends And Related Symbol Documentation

◆ wrap()