| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.UnixFDList
Description
A GUnixFDList contains a list of file descriptors. It owns the file
descriptors that it contains, closing them when finalized.
It may be wrapped in a
`GUnixFDMessage` and sent over a
Socket in the G_SOCKET_FAMILY_UNIX family by using
socketSendMessage and received using
socketReceiveMessage.
Before 2.74, <gio/gunixfdlist.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.
Since 2.74, the API is available for Windows.
Synopsis
- newtype UnixFDList = UnixFDList (ManagedPtr UnixFDList)
- class (GObject o, IsDescendantOf UnixFDList o) => IsUnixFDList o
- toUnixFDList :: (MonadIO m, IsUnixFDList o) => o -> m UnixFDList
- type family ResolveUnixFDListMethod (t :: Symbol) o where ...
- data UnixFDListAppendMethodInfo
- unixFDListAppend :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> Int32 -> m Int32
- data UnixFDListAppendTakeMethodInfo
- unixFDListAppendTake :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> Int32 -> m CSize
- data UnixFDListGetMethodInfo
- unixFDListGet :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> Int32 -> m Int32
- data UnixFDListGetLengthMethodInfo
- unixFDListGetLength :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> m Int32
- data UnixFDListLookupMethodInfo
- unixFDListLookup :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> CSize -> m Int32
- unixFDListNew :: (HasCallStack, MonadIO m) => m UnixFDList
- unixFDListNewFromArray :: (HasCallStack, MonadIO m) => [Int32] -> m UnixFDList
- data UnixFDListPeekMethodInfo
- unixFDListPeek :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> CSize -> m Int32
- data UnixFDListPeekFdsMethodInfo
- unixFDListPeekFds :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> m [Int32]
- data UnixFDListStealFdsMethodInfo
- unixFDListStealFds :: (HasCallStack, MonadIO m, IsUnixFDList a) => a -> m [Int32]
Exported types
newtype UnixFDList Source #
Memory-managed wrapper type.
Constructors
| UnixFDList (ManagedPtr UnixFDList) |
Instances
class (GObject o, IsDescendantOf UnixFDList o) => IsUnixFDList o Source #
Type class for types which can be safely cast to UnixFDList, for instance with toUnixFDList.
Instances
| (GObject o, IsDescendantOf UnixFDList o) => IsUnixFDList o Source # | |
Defined in GI.Gio.Objects.UnixFDList | |
toUnixFDList :: (MonadIO m, IsUnixFDList o) => o -> m UnixFDList Source #
Cast to UnixFDList, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
append, appendTake, bindProperty, bindPropertyFull, forceFloating, freezeNotify, get, getv, isFloating, lookup, notify, notifyByPspec, peek, peekFds, ref, refSink, runDispose, stealData, stealFds, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getLength, getProperty, getQdata.
Setters
type family ResolveUnixFDListMethod (t :: Symbol) o where ... Source #
Equations
append
data UnixFDListAppendMethodInfo Source #
Instances
| (signature ~ (Int32 -> m Int32), MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListAppendMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListAppendMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> Int32 |
|
| -> m Int32 | Returns: the index of the appended fd in case of success, else |
Adds a file descriptor to list.
The file descriptor is duplicated using dup(). You keep your copy
of the descriptor and the copy contained in list will be closed
when list is finalized.
A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.
The index of the file descriptor in the list is returned. If you use
this index with unixFDListGet then you will receive back a
duplicated copy of the same file descriptor.
Since: 2.24
appendTake
data UnixFDListAppendTakeMethodInfo Source #
Instances
| (signature ~ (Int32 -> m CSize), MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListAppendTakeMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListAppendTakeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> Int32 |
|
| -> m CSize | Returns: the index of the appended |
Adds a file descriptor to list.
After this call, fd belongs to the list and may no longer be closed by the
caller.
The file descriptor fd should be set to close-on-exec.
The index of the file descriptor in the list is returned. If you use this
index with unixFDListGet then you will receive back a
duplicated copy of the same file descriptor.
Since: 2.90
get
data UnixFDListGetMethodInfo Source #
Instances
| (signature ~ (Int32 -> m Int32), MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListGetMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListGetMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> Int32 |
|
| -> m Int32 | Returns: the file descriptor, or |
Gets a file descriptor out of list.
index_ specifies the index of the file descriptor to get. It is a
programmer error for index_ to be out of range. Either use
unixFDListLookup to do a checked lookup, or check the index
against the list length using unixFDListGetLength.
The file descriptor is duplicated using dup() and set as
close-on-exec before being returned. You must call close() on it
when you are done.
A possible cause of failure is exceeding the per-process or system-wide file descriptor limit.
Since: 2.24
getLength
data UnixFDListGetLengthMethodInfo Source #
Instances
| (signature ~ m Int32, MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListGetLengthMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListGetLengthMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> m Int32 | Returns: the length of |
Gets the length of list (ie: the number of file descriptors
contained within).
Since: 2.24
lookup
data UnixFDListLookupMethodInfo Source #
Instances
| (signature ~ (CSize -> m Int32), MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListLookupMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListLookupMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> CSize |
|
| -> m Int32 | Returns: the file descriptor, or |
Looks up a file descriptor in list at position index_.
index_ specifies the index of the file descriptor to get. If no file
descriptor exists at this index, -1 is returned.
After this call, the descriptor remains the property of list. The caller
must not close it. The descriptor is valid only until list is changed in any
way.
Since: 2.90
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m UnixFDList | Returns: a new |
Creates a new UnixFDList containing no file descriptors.
Since: 2.24
newFromArray
unixFDListNewFromArray Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => [Int32] |
|
| -> m UnixFDList | Returns: a new |
Creates a new UnixFDList containing the file descriptors given
in fds. The file descriptors become the property of the new list and may no
longer be used by the caller. The array itself is owned by the caller.
Each file descriptor in the array should be set to close-on-exec.
If nFds is -1 then fds must be terminated with -1.
Since: 2.24
peek
data UnixFDListPeekMethodInfo Source #
Instances
| (signature ~ (CSize -> m Int32), MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListPeekMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListPeekMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> CSize |
|
| -> m Int32 | Returns: the file descriptor |
Gets a file descriptor out of list.
index_ specifies the index of the file descriptor to get. It is a programmer
error for index_ to be out of range; see unixFDListGetLength.
This will always return a valid (non-negative) file descriptor.
After this call, the descriptor remains the property of list. The caller
must not close it. The descriptor is valid only until list is changed in any
way.
Since: 2.90
peekFds
data UnixFDListPeekFdsMethodInfo Source #
Instances
| (signature ~ m [Int32], MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListPeekFdsMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListPeekFdsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> 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 remain the property of list. The
caller must not close them and must not free the array. The array is
valid only until list is changed in any way.
If length is non-NULL 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 NULL. In case there are no file
descriptors contained in list, an empty array is returned.
Since: 2.24
stealFds
data UnixFDListStealFdsMethodInfo Source #
Instances
| (signature ~ m [Int32], MonadIO m, IsUnixFDList a) => OverloadedMethod UnixFDListStealFdsMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixFDListStealFdsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixFDList Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsUnixFDList a) | |
| => a |
|
| -> 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
list. Further calls will return an empty list (unless more
descriptors have been added).
The return result of this function must be freed with g_free().
The caller is also responsible for closing all of the file
descriptors. The file descriptors in the array are set to
close-on-exec.
If length is non-NULL 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 NULL. In case there are no file
descriptors contained in list, an empty array is returned.
Since: 2.24