GI.Gio.Objects.UnixSocketAddress

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 IOErrorEnumNotSupported errors. You can use unixSocketAddressAbstractNamesSupported to see if abstract names are supported.

Note that <gio/gunixsocketaddress.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file when using it.

Exported types

newtype UnixSocketAddress

Constructors

UnixSocketAddress (ManagedPtr UnixSocketAddress)

Instances

GObject UnixSocketAddress

Methods

gobjectType :: UnixSocketAddress -> IO GType

IsObject UnixSocketAddress

IsSocketAddress UnixSocketAddress

IsSocketConnectable UnixSocketAddress

IsUnixSocketAddress UnixSocketAddress

((~) * info (ResolveUnixSocketAddressMethod t UnixSocketAddress), MethodInfo * info UnixSocketAddress p) => IsLabel t (UnixSocketAddress -> p)

Methods

fromLabel :: Proxy# Symbol t -> UnixSocketAddress -> p

((~) * info (ResolveUnixSocketAddressMethod t UnixSocketAddress), MethodInfo * info UnixSocketAddress p) => IsLabelProxy t (UnixSocketAddress -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> UnixSocketAddress -> p

HasAttributeList * UnixSocketAddress

type AttributeList UnixSocketAddress

type AttributeList UnixSocketAddress

type SignalList UnixSocketAddress

type SignalList UnixSocketAddress

class GObject o => IsUnixSocketAddress o

Instances

(GObject a, UnknownAncestorError Constraint UnixSocketAddress a) => IsUnixSocketAddress a

IsUnixSocketAddress UnixSocketAddress

toUnixSocketAddress :: IsUnixSocketAddress o => o -> IO UnixSocketAddress

noUnixSocketAddress :: Maybe UnixSocketAddress

Methods

abstractNamesSupported

unixSocketAddressAbstractNamesSupported

Arguments

:: (HasCallStack, MonadIO m)

=> m Bool

Returns: True if supported, False otherwise

Checks if abstract UNIX domain socket names are supported.

Since: 2.22

getAddressType

data UnixSocketAddressGetAddressTypeMethodInfo

Instances

((~) * signature (m UnixSocketAddressType), MonadIO m, IsUnixSocketAddress a) => MethodInfo * UnixSocketAddressGetAddressTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixSocketAddressGetAddressTypeMethodInfo a -> signature -> s

unixSocketAddressGetAddressType

Arguments

:: (HasCallStack, MonadIO m, IsUnixSocketAddress a)

=> a

address: a InetSocketAddress

-> m UnixSocketAddressType

Returns: a UnixSocketAddressType

Gets address's type.

Since: 2.26

getIsAbstract

data UnixSocketAddressGetIsAbstractMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsUnixSocketAddress a) => MethodInfo * UnixSocketAddressGetIsAbstractMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixSocketAddressGetIsAbstractMethodInfo a -> signature -> s

unixSocketAddressGetIsAbstract

Arguments

:: (HasCallStack, MonadIO m, IsUnixSocketAddress a)

=> a

address: a InetSocketAddress

-> m Bool

Returns: True if the address is abstract, False otherwise

Deprecated: Use unixSocketAddressGetAddressType

Tests if address is abstract.

Since: 2.22

getPath

data UnixSocketAddressGetPathMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsUnixSocketAddress a) => MethodInfo * UnixSocketAddressGetPathMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixSocketAddressGetPathMethodInfo a -> signature -> s

unixSocketAddressGetPath

Arguments

:: (HasCallStack, MonadIO m, IsUnixSocketAddress a)

=> a

address: a InetSocketAddress

-> m Text

Returns: the path for address

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 unixSocketAddressGetPathLen to get the true length of this string.

Since: 2.22

getPathLen

data UnixSocketAddressGetPathLenMethodInfo

Instances

((~) * signature (m Word64), MonadIO m, IsUnixSocketAddress a) => MethodInfo * UnixSocketAddressGetPathLenMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixSocketAddressGetPathLenMethodInfo a -> signature -> s

unixSocketAddressGetPathLen

Arguments

:: (HasCallStack, MonadIO m, IsUnixSocketAddress a)

=> a

address: a InetSocketAddress

-> m Word64

Returns: the length of the path

Gets the length of address's path.

For details, see unixSocketAddressGetPath.

Since: 2.22

new

unixSocketAddressNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

path: the socket path

-> m UnixSocketAddress

Returns: a new UnixSocketAddress

Creates a new UnixSocketAddress for path.

To create abstract socket addresses, on systems that support that, use unixSocketAddressNewAbstract.

Since: 2.22

newAbstract

unixSocketAddressNewAbstract

Arguments

:: (HasCallStack, MonadIO m)

=> [Int8]

path: the abstract name

-> m UnixSocketAddress

Returns: a new UnixSocketAddress

Deprecated: Use unixSocketAddressNewWithType.

Creates a new UnixSocketAddressTypeAbstractPadded UnixSocketAddress for path.

newWithType

unixSocketAddressNewWithType

Arguments

:: (HasCallStack, MonadIO m)

=> [Int8]

path: the name

-> UnixSocketAddressType

type: a UnixSocketAddressType

-> m UnixSocketAddress

Returns: a new UnixSocketAddress

Creates a new UnixSocketAddress of type type with name path.

If type is UnixSocketAddressTypePath, this is equivalent to calling unixSocketAddressNew.

If type is UnixSocketAddressTypeAnonymous, path and pathLen will be ignored.

If pathType is UnixSocketAddressTypeAbstract, then pathLen bytes of path will be copied to the socket's path, and only those bytes will be considered part of the name. (If pathLen is -1, then path is assumed to be NUL-terminated.) For example, if path was "test", then calling socketAddressGetNativeSize 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 pathType is UnixSocketAddressTypeAbstractPadded, then pathLen 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 pathLen is -1, then path is assumed to be NUL-terminated.) In this case, socketAddressGetNativeSize will always return the full size of a struct sockaddr_un, although unixSocketAddressGetPathLen will still return just the length of path.

UnixSocketAddressTypeAbstract is preferred over UnixSocketAddressTypeAbstractPadded 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.

Since: 2.26

Properties

abstract

data UnixSocketAddressAbstractPropertyInfo

Instances

AttrInfo UnixSocketAddressAbstractPropertyInfo

Associated Types

type AttrAllowedOps UnixSocketAddressAbstractPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixSocketAddressAbstractPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo :: * -> Constraint

type AttrGetType UnixSocketAddressAbstractPropertyInfo :: *

type AttrLabel UnixSocketAddressAbstractPropertyInfo :: Symbol

type AttrOrigin UnixSocketAddressAbstractPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo o => Proxy * UnixSocketAddressAbstractPropertyInfo -> o -> IO (AttrGetType UnixSocketAddressAbstractPropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressAbstractPropertyInfo b) => Proxy * UnixSocketAddressAbstractPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo o => Proxy * UnixSocketAddressAbstractPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressAbstractPropertyInfo b) => Proxy * UnixSocketAddressAbstractPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixSocketAddressAbstractPropertyInfo

type AttrOrigin UnixSocketAddressAbstractPropertyInfo = UnixSocketAddress

type AttrLabel UnixSocketAddressAbstractPropertyInfo

type AttrLabel UnixSocketAddressAbstractPropertyInfo = "abstract"

type AttrGetType UnixSocketAddressAbstractPropertyInfo

type AttrGetType UnixSocketAddressAbstractPropertyInfo = Bool

type AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo

type AttrBaseTypeConstraint UnixSocketAddressAbstractPropertyInfo = IsUnixSocketAddress

type AttrSetTypeConstraint UnixSocketAddressAbstractPropertyInfo

type AttrSetTypeConstraint UnixSocketAddressAbstractPropertyInfo = * ~ Bool

type AttrAllowedOps UnixSocketAddressAbstractPropertyInfo

type AttrAllowedOps UnixSocketAddressAbstractPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructUnixSocketAddressAbstract :: IsUnixSocketAddress o => Bool -> IO (GValueConstruct o)

getUnixSocketAddressAbstract :: (MonadIO m, IsUnixSocketAddress o) => o -> m Bool

unixSocketAddressAbstract :: AttrLabelProxy "abstract"

addressType

data UnixSocketAddressAddressTypePropertyInfo

Instances

AttrInfo UnixSocketAddressAddressTypePropertyInfo

Associated Types

type AttrAllowedOps UnixSocketAddressAddressTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixSocketAddressAddressTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo :: * -> Constraint

type AttrGetType UnixSocketAddressAddressTypePropertyInfo :: *

type AttrLabel UnixSocketAddressAddressTypePropertyInfo :: Symbol

type AttrOrigin UnixSocketAddressAddressTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo o => Proxy * UnixSocketAddressAddressTypePropertyInfo -> o -> IO (AttrGetType UnixSocketAddressAddressTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo o, AttrSetTypeConstraint UnixSocketAddressAddressTypePropertyInfo b) => Proxy * UnixSocketAddressAddressTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo o => Proxy * UnixSocketAddressAddressTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo o, AttrSetTypeConstraint UnixSocketAddressAddressTypePropertyInfo b) => Proxy * UnixSocketAddressAddressTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixSocketAddressAddressTypePropertyInfo

type AttrOrigin UnixSocketAddressAddressTypePropertyInfo = UnixSocketAddress

type AttrLabel UnixSocketAddressAddressTypePropertyInfo

type AttrLabel UnixSocketAddressAddressTypePropertyInfo = "address-type"

type AttrGetType UnixSocketAddressAddressTypePropertyInfo

type AttrGetType UnixSocketAddressAddressTypePropertyInfo = UnixSocketAddressType

type AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo

type AttrBaseTypeConstraint UnixSocketAddressAddressTypePropertyInfo = IsUnixSocketAddress

type AttrSetTypeConstraint UnixSocketAddressAddressTypePropertyInfo

type AttrSetTypeConstraint UnixSocketAddressAddressTypePropertyInfo = * ~ UnixSocketAddressType

type AttrAllowedOps UnixSocketAddressAddressTypePropertyInfo

type AttrAllowedOps UnixSocketAddressAddressTypePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructUnixSocketAddressAddressType :: IsUnixSocketAddress o => UnixSocketAddressType -> IO (GValueConstruct o)

getUnixSocketAddressAddressType :: (MonadIO m, IsUnixSocketAddress o) => o -> m UnixSocketAddressType

unixSocketAddressAddressType :: AttrLabelProxy "addressType"

path

data UnixSocketAddressPathPropertyInfo

Instances

AttrInfo UnixSocketAddressPathPropertyInfo

Associated Types

type AttrAllowedOps UnixSocketAddressPathPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixSocketAddressPathPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo :: * -> Constraint

type AttrGetType UnixSocketAddressPathPropertyInfo :: *

type AttrLabel UnixSocketAddressPathPropertyInfo :: Symbol

type AttrOrigin UnixSocketAddressPathPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo o => Proxy * UnixSocketAddressPathPropertyInfo -> o -> IO (AttrGetType UnixSocketAddressPathPropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressPathPropertyInfo b) => Proxy * UnixSocketAddressPathPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo o => Proxy * UnixSocketAddressPathPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressPathPropertyInfo b) => Proxy * UnixSocketAddressPathPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixSocketAddressPathPropertyInfo

type AttrOrigin UnixSocketAddressPathPropertyInfo = UnixSocketAddress

type AttrLabel UnixSocketAddressPathPropertyInfo

type AttrLabel UnixSocketAddressPathPropertyInfo = "path"

type AttrGetType UnixSocketAddressPathPropertyInfo

type AttrGetType UnixSocketAddressPathPropertyInfo = Text

type AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo

type AttrBaseTypeConstraint UnixSocketAddressPathPropertyInfo = IsUnixSocketAddress

type AttrSetTypeConstraint UnixSocketAddressPathPropertyInfo

type AttrSetTypeConstraint UnixSocketAddressPathPropertyInfo = * ~ Text

type AttrAllowedOps UnixSocketAddressPathPropertyInfo

type AttrAllowedOps UnixSocketAddressPathPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructUnixSocketAddressPath :: IsUnixSocketAddress o => Text -> IO (GValueConstruct o)

getUnixSocketAddressPath :: (MonadIO m, IsUnixSocketAddress o) => o -> m Text

unixSocketAddressPath :: AttrLabelProxy "path"

pathAsArray

data UnixSocketAddressPathAsArrayPropertyInfo

Instances

AttrInfo UnixSocketAddressPathAsArrayPropertyInfo

Associated Types

type AttrAllowedOps UnixSocketAddressPathAsArrayPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo :: * -> Constraint

type AttrGetType UnixSocketAddressPathAsArrayPropertyInfo :: *

type AttrLabel UnixSocketAddressPathAsArrayPropertyInfo :: Symbol

type AttrOrigin UnixSocketAddressPathAsArrayPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo o => Proxy * UnixSocketAddressPathAsArrayPropertyInfo -> o -> IO (AttrGetType UnixSocketAddressPathAsArrayPropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo b) => Proxy * UnixSocketAddressPathAsArrayPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo o => Proxy * UnixSocketAddressPathAsArrayPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo o, AttrSetTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo b) => Proxy * UnixSocketAddressPathAsArrayPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixSocketAddressPathAsArrayPropertyInfo

type AttrOrigin UnixSocketAddressPathAsArrayPropertyInfo = UnixSocketAddress

type AttrLabel UnixSocketAddressPathAsArrayPropertyInfo

type AttrLabel UnixSocketAddressPathAsArrayPropertyInfo = "path-as-array"

type AttrGetType UnixSocketAddressPathAsArrayPropertyInfo

type AttrGetType UnixSocketAddressPathAsArrayPropertyInfo = Maybe ByteString

type AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo

type AttrBaseTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo = IsUnixSocketAddress

type AttrSetTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo

type AttrSetTypeConstraint UnixSocketAddressPathAsArrayPropertyInfo = * ~ ByteString

type AttrAllowedOps UnixSocketAddressPathAsArrayPropertyInfo

type AttrAllowedOps UnixSocketAddressPathAsArrayPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructUnixSocketAddressPathAsArray :: IsUnixSocketAddress o => ByteString -> IO (GValueConstruct o)

getUnixSocketAddressPathAsArray :: (MonadIO m, IsUnixSocketAddress o) => o -> m (Maybe ByteString)

unixSocketAddressPathAsArray :: AttrLabelProxy "pathAsArray"