GI.Gio.Objects.UnixFDMessage

This SocketControlMessage contains a UnixFDList. It may be sent using socketSendMessage and received using socketReceiveMessage over UNIX sockets (ie: sockets in the G_SOCKET_ADDRESS_UNIX family). The file descriptors are copied between processes by the kernel.

For an easier way to send and receive file descriptors over stream-oriented UNIX sockets, see unixConnectionSendFd and unixConnectionReceiveFd.

Note that <gio/gunixfdmessage.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 UnixFDMessage

Constructors

UnixFDMessage (ManagedPtr UnixFDMessage)

Instances

GObject UnixFDMessage

Methods

gobjectType :: UnixFDMessage -> IO GType

IsObject UnixFDMessage

IsSocketControlMessage UnixFDMessage

IsUnixFDMessage UnixFDMessage

((~) * info (ResolveUnixFDMessageMethod t UnixFDMessage), MethodInfo * info UnixFDMessage p) => IsLabel t (UnixFDMessage -> p)

Methods

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

((~) * info (ResolveUnixFDMessageMethod t UnixFDMessage), MethodInfo * info UnixFDMessage p) => IsLabelProxy t (UnixFDMessage -> p)

Methods

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

HasAttributeList * UnixFDMessage

type AttributeList UnixFDMessage

type AttributeList UnixFDMessage

type SignalList UnixFDMessage

type SignalList UnixFDMessage

class GObject o => IsUnixFDMessage o

Instances

(GObject a, UnknownAncestorError Constraint UnixFDMessage a) => IsUnixFDMessage a

IsUnixFDMessage UnixFDMessage

toUnixFDMessage :: IsUnixFDMessage o => o -> IO UnixFDMessage

noUnixFDMessage :: Maybe UnixFDMessage

Methods

appendFd

data UnixFDMessageAppendFdMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsUnixFDMessage a) => MethodInfo * UnixFDMessageAppendFdMethodInfo a signature

Methods

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

unixFDMessageAppendFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixFDMessage a)

=> a

message: a UnixFDMessage

-> Int32

fd: a valid open file descriptor

-> m ()

(Can throw GError)

Adds a file descriptor to message.

The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in message will be closed when message is finalized.

A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.

Since: 2.22

getFdList

data UnixFDMessageGetFdListMethodInfo

Instances

((~) * signature (m UnixFDList), MonadIO m, IsUnixFDMessage a) => MethodInfo * UnixFDMessageGetFdListMethodInfo a signature

Methods

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

unixFDMessageGetFdList

Arguments

:: (HasCallStack, MonadIO m, IsUnixFDMessage a)

=> a

message: a UnixFDMessage

-> m UnixFDList

Returns: the UnixFDList from message

Gets the UnixFDList contained in message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of message.

Since: 2.24

new

unixFDMessageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m UnixFDMessage

Returns: a new UnixFDMessage

Creates a new UnixFDMessage containing an empty file descriptor list.

Since: 2.22

newWithFdList

unixFDMessageNewWithFdList

Arguments

:: (HasCallStack, MonadIO m, IsUnixFDList a)

=> a

fdList: a UnixFDList

-> m UnixFDMessage

Returns: a new UnixFDMessage

Creates a new UnixFDMessage containing list.

Since: 2.24

stealFds

data UnixFDMessageStealFdsMethodInfo

Instances

((~) * signature (m [Int32]), MonadIO m, IsUnixFDMessage a) => MethodInfo * UnixFDMessageStealFdsMethodInfo a signature

Methods

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

unixFDMessageStealFds

Arguments

:: (HasCallStack, MonadIO m, IsUnixFDMessage a)

=> a

message: a UnixFDMessage

-> m [Int32]

Returns: an array of file descriptors

Returns the array of file descriptors that is contained in this object.

After this call, the descriptors are no longer contained in message. Further calls will return an empty list (unless more descriptors have been added).

The return result of this function must be freed with free. The caller is also responsible for closing all of the file descriptors.

If length is non-Nothing then it is set to the number of file descriptors in the returned array. The returned array is also terminated with -1.

This function never returns Nothing. In case there are no file descriptors contained in message, an empty array is returned.

Since: 2.22

Properties

fdList

data UnixFDMessageFdListPropertyInfo

Instances

AttrInfo UnixFDMessageFdListPropertyInfo

Associated Types

type AttrAllowedOps UnixFDMessageFdListPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixFDMessageFdListPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixFDMessageFdListPropertyInfo :: * -> Constraint

type AttrGetType UnixFDMessageFdListPropertyInfo :: *

type AttrLabel UnixFDMessageFdListPropertyInfo :: Symbol

type AttrOrigin UnixFDMessageFdListPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin UnixFDMessageFdListPropertyInfo

type AttrOrigin UnixFDMessageFdListPropertyInfo = UnixFDMessage

type AttrLabel UnixFDMessageFdListPropertyInfo

type AttrLabel UnixFDMessageFdListPropertyInfo = "fd-list"

type AttrGetType UnixFDMessageFdListPropertyInfo

type AttrGetType UnixFDMessageFdListPropertyInfo = UnixFDList

type AttrBaseTypeConstraint UnixFDMessageFdListPropertyInfo

type AttrBaseTypeConstraint UnixFDMessageFdListPropertyInfo = IsUnixFDMessage

type AttrSetTypeConstraint UnixFDMessageFdListPropertyInfo

type AttrSetTypeConstraint UnixFDMessageFdListPropertyInfo = IsUnixFDList

type AttrAllowedOps UnixFDMessageFdListPropertyInfo

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

constructUnixFDMessageFdList :: (IsUnixFDMessage o, IsUnixFDList a) => a -> IO (GValueConstruct o)

getUnixFDMessageFdList :: (MonadIO m, IsUnixFDMessage o) => o -> m UnixFDList

unixFDMessageFdList :: AttrLabelProxy "fdList"