glibmm: Gio::UnixSocketAddress Class Reference
UnixSocketAddress - UNIX SocketAddress . More...
#include <giomm/unixsocketaddress.h>

Public Member Functions |
|
UnixSocketAddress ( UnixSocketAddress && src) noexcept | |
UnixSocketAddress & | operator= ( UnixSocketAddress && src) noexcept |
~UnixSocketAddress () noexceptoverride | |
GUnixSocketAddress* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GUnixSocketAddress* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GUnixSocketAddress* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
More...
|
|
UnixSocketAddressType | get_address_type () const |
Gets
address's
type.
More...
|
|
std::string | get_path () const |
Gets
address's
path, or for abstract sockets the "name".
More...
|
|
Glib::PropertyProxy_ReadOnly < bool > | property_abstract () const |
Whether or not this is an abstract address.
More...
|
|
Glib::PropertyProxy_ReadOnly < UnixSocketAddressType > | property_address_type () const |
The type of UNIX socket address.
More...
|
|
Glib::PropertyProxy_ReadOnly < std::string > | property_path () const |
UNIX socket path.
More...
|
|
Glib::PropertyProxy_ReadOnly < Glib::RefPtr < ByteArray > > | property_path_as_array () const |
UNIX socket path, as byte array.
More...
|
|
![]() |
|
SocketAddress ( SocketAddress && src) noexcept | |
SocketAddress & | operator= ( SocketAddress && src) noexcept |
~SocketAddress () noexceptoverride | |
GSocketAddress* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GSocketAddress* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GSocketAddress* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
More...
|
|
SocketFamily | get_family () const |
Gets the socket family type of
address
.
More...
|
|
bool | to_native (gpointer dest, gsize destlen) |
Converts a
SocketAddress
to a native struct sockaddr, which can be passed to low-level functions like connect() or
bind()
.
More...
|
|
gssize | get_native_size () const |
Gets the size of
address's
native struct sockaddr.
More...
|
|
Glib::PropertyProxy_ReadOnly < Glib::RefPtr < SocketFamily > > | property_family () const |
The family of the socket address.
More...
|
|
![]() |
|
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 (const Quark & key, void* data, DestroyNotify notify) |
void | remove_data (const QueryQuark & quark) |
void* | steal_data (const QueryQuark & quark) |
![]() |
|
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.
More...
|
|
void | get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const |
You probably want to use a specific property_*() accessor method instead.
More...
|
|
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.
More...
|
|
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.
More...
|
|
void | 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.
More...
|
|
void | connect_property_changed (const Glib::ustring & property_name, sigc::slot < void >&& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
sigc::connection | connect_property_changed_with_return (const Glib::ustring & property_name, const sigc::slot < void >& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
sigc::connection | connect_property_changed_with_return (const Glib::ustring & property_name, sigc::slot < void >&& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
void | freeze_notify () |
Increases the freeze count on object.
More...
|
|
void | thaw_notify () |
Reverts the effect of a previous call to
freeze_notify()
.
More...
|
|
virtual void | reference () const |
Increment the reference count for this object.
More...
|
|
virtual void | unreference () const |
Decrement the reference count for this object.
More...
|
|
GObject* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GObject* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GObject* | gobj_copy () const |
Give a ref-ed copy to someone. Use for direct struct access.
More...
|
|
![]() |
|
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable ( trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= ( trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
![]() |
|
SocketConnectable ( SocketConnectable && src) noexcept | |
SocketConnectable & | operator= ( SocketConnectable && src) noexcept |
~SocketConnectable () noexceptoverride | |
GSocketConnectable* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GSocketConnectable* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
Glib::RefPtr < SocketAddressEnumerator > | enumerate () |
Creates a
SocketAddressEnumerator
for
connectable
.
More...
|
|
Glib::RefPtr < const SocketAddressEnumerator > | enumerate () const |
Creates a
SocketAddressEnumerator
for
connectable
.
More...
|
|
Glib::RefPtr < SocketAddressEnumerator > | proxy_enumerate () |
Creates a
SocketAddressEnumerator
for
connectable
that will return ProxyAddresses for addresses that you must connect to via a proxy.
More...
|
|
Glib::RefPtr < const SocketAddressEnumerator > | proxy_enumerate () const |
Creates a
SocketAddressEnumerator
for
connectable
that will return ProxyAddresses for addresses that you must connect to via a proxy.
More...
|
|
Glib::ustring | to_string () const |
Format a
SocketConnectable
as a string.
More...
|
|
![]() |
|
Interface () | |
A Default constructor.
More...
|
|
Interface ( Interface && src) noexcept | |
Interface & | operator= ( Interface && src) noexcept |
Interface (const Glib::Interface_Class& interface_class) | |
Called by constructors of derived classes.
More...
|
|
Interface (GObject* castitem) | |
Called by constructors of derived classes.
More...
|
|
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject* | gobj () |
const GObject* | gobj () const |
Static Public Member Functions |
|
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
static Glib::RefPtr < UnixSocketAddress > | create (const std::string & path) |
Creates a new
UnixSocketAddress
for
path
.
More...
|
|
static Glib::RefPtr < UnixSocketAddress > | create (const std::string & path, UnixSocketAddressType type= Gio::UNIX_SOCKET_ADDRESS_ABSTRACT , int path_len=-1) |
Creates a new
UnixSocketAddress
of type
type
with name
path
.
More...
|
|
static bool | abstract_names_supported () |
Checks if abstract UNIX domain socket names are supported.
More...
|
|
![]() |
|
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
static Glib::RefPtr < SocketAddress > | create (gpointer native, gsize len) |
![]() |
|
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
Protected Member Functions |
|
UnixSocketAddress (const std::string & path) | |
![]() |
|
Object () | |
Object (const Glib::ConstructParams& construct_params) | |
Object (GObject* castitem) | |
~Object () noexceptoverride | |
![]() |
|
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.
More...
|
|
ObjectBase (const char* custom_type_name) | |
A derived constructor always overrides this choice.
More...
|
|
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.
More...
|
|
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) |
![]() |
|
SocketConnectable () | |
You should derive from this class to use it.
More...
|
|
Related Functions |
|
(Note that these are not member functions.) |
|
Glib::RefPtr < Gio::UnixSocketAddress > | wrap (GUnixSocketAddress* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
![]() |
|
Glib::RefPtr < Gio::SocketAddress > | wrap (GSocketAddress* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
![]() |
|
Glib::RefPtr < Glib::Object > | wrap (GObject* object, bool take_copy=false) |
![]() |
|
Glib::RefPtr < Gio::SocketConnectable > | wrap (GSocketConnectable* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
Additional Inherited Members |
|
![]() |
|
using | DestroyNotify = void(*)(gpointer data) |
![]() |
|
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
UnixSocketAddress - UNIX SocketAddress .
Support for UNIX-domain (also known as local) sockets.
UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not visible in the filesystem and not affected by the filesystem permissions, visibility, etc. Currently this is only supported under Linux. If you attempt to use abstract sockets on other systems, function calls may return Gio::IO_ERROR_NOT_SUPPORTED errors. You can use Gio::UnixSocketAddress::abstract_names_supported() to see if abstract names are supported.
Note that
<giomm/unixsocketaddress.h>
belongs to the UNIX-specific GIO interfaces.
Constructor & Destructor Documentation
|
noexcept |
|
override noexcept |
|
explicit protected |
Member Function Documentation
|
static |
Checks if abstract UNIX domain socket names are supported.
- Returns
-
true
if supported,false
otherwise.
|
static |
Creates a new UnixSocketAddress for path .
To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract().
- Parameters
-
path The socket path.
- Returns
- A new UnixSocketAddress .
|
static |
Creates a new UnixSocketAddress of type type with name path .
If type is UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new().
If type is UNIX_SOCKET_ADDRESS_ANONYMOUS, path and path_len will be ignored.
If path_type is UNIX_SOCKET_ADDRESS_ABSTRACT, then path_len bytes of path will be copied to the socket's path, and only those bytes will be considered part of the name. (If path_len is -1, then path is assumed to be NUL-terminated.) For example, if path was "test", then calling g_socket_address_get_native_size() on the returned socket would return 7 (2 bytes of overhead, 1 byte for the abstract-socket indicator byte, and 4 bytes for the name "test").
If
path_type
is UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
path_len
bytes of
path
will be copied to the socket's path, the rest of the path will be padded with 0 bytes, and the entire zero-padded buffer will be considered the name. (As above, if
path_len
is -1, then
path
is assumed to be NUL-terminated.) In this case, g_socket_address_get_native_size() will always return the full size of a
struct sockaddr_un
, although g_unix_socket_address_get_path_len() will still return just the length of
path
.
UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course, when connecting to a server created by another process, you must use the appropriate type corresponding to how that process created its listening socket.
- Parameters
-
path The name. path_len The length of path , or -1. type A UnixSocketAddressType.
- Returns
- A new UnixSocketAddress .
UnixSocketAddressType Gio::UnixSocketAddress::get_address_type | ( | ) | const |
std::string Gio::UnixSocketAddress::get_path | ( | ) | const |
Gets address's path, or for abstract sockets the "name".
Guaranteed to be zero-terminated, but an abstract socket may contain embedded zeros, and thus you should use g_unix_socket_address_get_path_len() to get the true length of this string.
- Returns
- The path for address .
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GUnixSocketAddress* Gio::UnixSocketAddress::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
noexcept |
Glib::PropertyProxy_ReadOnly < bool > Gio::UnixSocketAddress::property_abstract | ( | ) | const |
Whether or not this is an abstract address.
Deprecated: Use UnixSocketAddress::property_address_type() , which distinguishes between zero-padded and non-zero-padded abstract addresses.
- Deprecated:
- Use property_address_type() instead, which distinguishes between zero-padded and non-zero-padded abstract addresses.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < UnixSocketAddressType > Gio::UnixSocketAddress::property_address_type | ( | ) | const |
The type of UNIX socket address.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < std::string > Gio::UnixSocketAddress::property_path | ( | ) | const |
UNIX socket path.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < Glib::RefPtr <ByteArray> > Gio::UnixSocketAddress::property_path_as_array | ( | ) | const |
UNIX socket path, as byte array.
- 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 Function Documentation
|
related |
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.