glibmm: Gio::SocketConnection Class Reference

A socket connection. More...

#include <giomm/socketconnection.h>

Inheritance diagram for Gio::SocketConnection:

[legend]

Public Member Functions
	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 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::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 socket connection.

See also: IOStream, SocketClient, SocketListener

SocketConnection is a IOStream for a connected socket. They can be created either by SocketClient when connecting to a host, or by SocketListener when accepting a new client.

The type of the SocketConnection object returned from these calls depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a TcpConnection.

Chosing what type of object to construct is done with the socket connection factory, and it is possible for 3rd parties to register custom socket connection types for specific combination of socket family/type/protocol using g_socket_connection_factory_register_type().

Since glibmm 2.24:

Constructor & Destructor Documentation

◆ SocketConnection()

Gio::SocketConnection::SocketConnection ( SocketConnection && src )

noexcept

◆ ~SocketConnection()

Gio::SocketConnection::~SocketConnection ( )

overridenoexcept

Member Function Documentation

◆ connect() [1/2]

bool Gio::SocketConnection::connect ( const Glib::RefPtr< SocketAddress > & address )

A connect() convenience overload.

◆ connect() [2/2]

bool Gio::SocketConnection::connect	(	const Glib::RefPtr< SocketAddress > &	address,
		const Glib::RefPtr< Cancellable > &	cancellable
	)

Connect connection to the specified remote address.

Since glibmm 2.32:

Parameters

address	A SocketAddress specifying the remote address.
cancellable	A Cancellable or `nullptr`.

Returns: true if the connection succeeded, false on error.

Exceptions

Glib::Error

◆ connect_async() [1/2]

void Gio::SocketConnection::connect_async	(	const Glib::RefPtr< SocketAddress > &	address,
		const SlotAsyncReady &	slot
	)

A non-cancellable version of connect_async().

◆ connect_async() [2/2]

void Gio::SocketConnection::connect_async	(	const Glib::RefPtr< SocketAddress > &	address,
		const SlotAsyncReady &	slot,
		const Glib::RefPtr< Cancellable > &	cancellable
	)

Asynchronously connect this connection to the specified remote address.

This clears the "blocking" flag on this connection's underlying socket if it is currently set.

Use connect_finish() to retrieve the result.

Parameters

address	A SocketAddress specifying the remote address.
slot	A SlotAsyncReady slot.
cancellable	A Cancellable.

Since glibmm 2.36:

◆ connect_finish()

bool Gio::SocketConnection::connect_finish ( const Glib::RefPtr< AsyncResult > & result )

Gets the result of a g_socket_connection_connect_async() call.

Since glibmm 2.32:

Parameters

result The AsyncResult.

Returns: true if the connection succeeded, false on error.

Exceptions

Glib::Error

◆ create()

static Glib::RefPtr< SocketConnection > Gio::SocketConnection::create ( const Glib::RefPtr< Socket > & socket )

static

Creates a SocketConnection subclass of the right type for socket.

Since glibmm 2.22:

Parameters

socket A Socket.

Returns: A SocketConnection.

◆ get_local_address() [1/2]

Glib::RefPtr< SocketAddress > Gio::SocketConnection::get_local_address ( )

Try to get the local address of a socket connection.

Since glibmm 2.22:

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

Exceptions

Glib::Error

◆ get_local_address() [2/2]

Glib::RefPtr< const SocketAddress > Gio::SocketConnection::get_local_address ( ) const

Try to get the local address of a socket connection.

Since glibmm 2.22:

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

Exceptions

Glib::Error

◆ get_remote_address() [1/2]

Glib::RefPtr< SocketAddress > Gio::SocketConnection::get_remote_address ( )

Try to get the remote address of a socket connection.

Since GLib 2.40, when used with g_socket_client_connect() or g_socket_client_connect_async(), during emission of Gio::SocketClientEvent::CONNECTING, this function will return the remote address that will be used for the connection. This allows applications to print e.g. "Connecting to example.com (10.42.77.3)...".

Since glibmm 2.22:

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

Exceptions

Glib::Error

◆ get_remote_address() [2/2]

Glib::RefPtr< const SocketAddress > Gio::SocketConnection::get_remote_address ( ) const

Try to get the remote address of a socket connection.

Since glibmm 2.22:

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

Exceptions

Glib::Error

◆ get_socket() [1/2]

Glib::RefPtr< Socket > Gio::SocketConnection::get_socket ( )

Gets the underlying Socket object of the connection.

This can be useful if you want to do something unusual on it not supported by the SocketConnection APIs.

Since glibmm 2.22:

Returns: A Socket or nullptr on error.

◆ get_socket() [2/2]

Glib::RefPtr< const Socket > Gio::SocketConnection::get_socket ( ) const

Gets the underlying Socket object of the connection.

This can be useful if you want to do something unusual on it not supported by the SocketConnection APIs.

Since glibmm 2.22:

Returns: A Socket or nullptr on error.

◆ get_type()

static GType Gio::SocketConnection::get_type ( )

static

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

◆ gobj() [1/2]

GSocketConnection * Gio::SocketConnection::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GSocketConnection * Gio::SocketConnection::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GSocketConnection * Gio::SocketConnection::gobj_copy ( )

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

◆ is_connected()

bool Gio::SocketConnection::is_connected ( ) const

Checks if connection is connected.

This is equivalent to calling g_socket_is_connected() on connection's underlying Socket.

Since glibmm 2.32:

Returns: Whether connection is connected.

◆ operator=()

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

noexcept

◆ property_socket()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Socket > > Gio::SocketConnection::property_socket ( ) const

The underlying Gio::Socket.

Since glibmm 2.22:

Returns: A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gio::SocketConnection > wrap	(	GSocketConnection *	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

◆ SocketConnection()

◆ ~SocketConnection()

Member Function Documentation

◆ connect() [1/2]

◆ connect() [2/2]

◆ connect_async() [1/2]

◆ connect_async() [2/2]

◆ connect_finish()

◆ create()

◆ get_local_address() [1/2]

◆ get_local_address() [2/2]

◆ get_remote_address() [1/2]

◆ get_remote_address() [2/2]

◆ get_socket() [1/2]

◆ get_socket() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ is_connected()

◆ operator=()

◆ property_socket()

Friends And Related Symbol Documentation

◆ wrap()