class Gio::UnixSocketAddress

Overview

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 %G_IO_ERROR_NOT_SUPPORTED errors. You can use g_unix_socket_address_abstract_names_supported() to see if abstract names are supported.

Since GLib 2.72, #GUnixSocketAddress is available on all platforms. It requires underlying system support (such as Windows 10 with AF_UNIX) at run time.

Before GLib 2.72, <gio/gunixsocketaddress.h> belonged to the UNIX-specific GIO interfaces, thus you had to use the gio-unix-2.0.pc pkg-config file when using it. This is no longer necessary since GLib 2.72.

Included Modules

Defined in:

lib/gi-crystal/src/auto/gio-2.0/unix_socket_address.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gio::SocketConnectable

enumerate : Gio::SocketAddressEnumerator enumerate, proxy_enumerate : Gio::SocketAddressEnumerator proxy_enumerate, to_string : String to_string, to_unsafe to_unsafe

Constructor methods inherited from module Gio::SocketConnectable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gio::SocketConnectable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class Gio::SocketAddress

==(other : self) ==, family : Gio::SocketFamily family, hash(hasher) hash, native_size : Int64 native_size, to_native(dest : Pointer(Void) | Nil, destlen : UInt64) : Bool to_native

Constructor methods inherited from class Gio::SocketAddress

new
new(*, family : Gio::SocketFamily | Nil = nil) new, new_from_native(native : Pointer(Void), len : UInt64) : self new_from_native

Class methods inherited from class Gio::SocketAddress

g_type : UInt64 g_type

Instance methods inherited from module Gio::SocketConnectable

enumerate : Gio::SocketAddressEnumerator enumerate, proxy_enumerate : Gio::SocketAddressEnumerator proxy_enumerate, to_string : String to_string, to_unsafe to_unsafe

Constructor methods inherited from module Gio::SocketConnectable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gio::SocketConnectable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(path : String) : self #

Creates a new #GUnixSocketAddress for path.

To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract().


[View source]
def self.new #

Initialize a new UnixSocketAddress.


[View source]
def self.new(*, abstract _abstract : Bool | Nil = nil, address_type : Gio::UnixSocketAddressType | Nil = nil, family : Gio::SocketFamily | Nil = nil, path : String | Nil = nil, path_as_array : Bytes | Nil = nil) #

[View source]
def self.new_abstract(path : Enumerable(Int8)) : self #

Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED #GUnixSocketAddress for path.

DEPRECATED


[View source]
def self.new_with_type(path : Enumerable(Int8), type : Gio::UnixSocketAddressType) : self #

Creates a new #GUnixSocketAddress of type type with name path.

If type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new().

If type is %G_UNIX_SOCKET_ADDRESS_ANONYMOUS, path and path_len will be ignored.

If path_type is %G_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 %G_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.

%G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over %G_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.


[View source]

Class Method Detail

def self.abstract_names_supported : Bool #

Checks if abstract UNIX domain socket names are supported.


[View source]
def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]
def self.new_abstract(*path : Int8) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def abstract=(value : Bool) : Bool #

[View source]
def abstract? : Bool #

[View source]
def address_type : Gio::UnixSocketAddressType #

Gets address's type.


[View source]
def address_type=(value : Gio::UnixSocketAddressType) : Gio::UnixSocketAddressType #

[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def is_abstract : Bool #

Tests if address is abstract.

DEPRECATED


[View source]
def path : String #

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.


[View source]
def path=(value : String) : String #

[View source]
def path=(value : Nil) : Nil #

Set #path property to nil.


[View source]
def path? : String | Nil #

Same as #path, but can return nil.


[View source]
def path_as_array : Bytes #

[View source]
def path_as_array=(value : Bytes) : Bytes #

[View source]
def path_len : UInt64 #

Gets the length of address's path.

For details, see g_unix_socket_address_get_path().


[View source]