class: UnixSocketAddressMeta

[230:14] static extends: object

Generated metadata helpers for UnixSocketAddress class surfaces.

Methods

• properties ()

  Returns property metadata for UnixSocketAddress.

  • @r A list.

class: UnixSocketAddressCtors

[171:14] static extends: object

Alternate constructors for UnixSocketAddress. Usage: UnixSocketAddressCtors.<name>(...). The primary constructor lives directly on UnixSocketAddress.

Methods

• newAbstract (list path)

  Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED #GUnixSocketAddress for @path.

  • @p path is the abstract name.
  • @p path_len is the length of @path, or -1.
  • @r A new UnixSocketAddress.

• newWithType (list path, string type)

  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.
  • @p path is the name.
  • @p path_len is the length of @path, or -1.
  • @p type is a #GUnixSocketAddressType.
  • @r A new UnixSocketAddress.

class: UnixSocketAddress

[26:7] extends: object

Support for UNIX-domain (also known as local) sockets, corresponding to struct sockaddr_un. 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 [func@Gio.UnixSocketAddress.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.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• UnixSocketAddress (path = null)

  Creates a new #GUnixSocketAddress for @path. To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract().

  • @p path is the socket path.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asSocketAddress ()

  Wraps this handle as SocketAddress.

  • @r A SocketAddress object.

• asSocketConnectable ()

  Wraps this handle as SocketConnectable.

  • @r A SocketConnectable object.

• get_address_type ()

  Gets @address's type.

• get_is_abstract ()

  Tests if @address is abstract.

• get_path ()

  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.

• get_path_len ()

  Gets the length of @address's path. For details, see g_unix_socket_address_get_path().