| 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.UnixCredentialsMessage
Description
This SocketControlMessage contains a Credentials
instance. It may be sent using socketSendMessage and received
using socketReceiveMessage over UNIX sockets (ie: sockets in
the G_SOCKET_FAMILY_UNIX family).
For an easier way to send and receive credentials over
stream-oriented UNIX sockets, see
unixConnectionSendCredentials and
unixConnectionReceiveCredentials. To receive credentials of
a foreign process connected to a socket, use
socketGetCredentials.
Since GLib 2.72, GUnixCredentialMessage 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/gunixcredentialsmessage.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.
Since: 2.26
Synopsis
- newtype UnixCredentialsMessage = UnixCredentialsMessage (ManagedPtr UnixCredentialsMessage)
- class (GObject o, IsDescendantOf UnixCredentialsMessage o) => IsUnixCredentialsMessage o
- toUnixCredentialsMessage :: (MonadIO m, IsUnixCredentialsMessage o) => o -> m UnixCredentialsMessage
- type family ResolveUnixCredentialsMessageMethod (t :: Symbol) o where ...
- data UnixCredentialsMessageGetCredentialsMethodInfo
- unixCredentialsMessageGetCredentials :: (HasCallStack, MonadIO m, IsUnixCredentialsMessage a) => a -> m Credentials
- unixCredentialsMessageIsSupported :: (HasCallStack, MonadIO m) => m Bool
- unixCredentialsMessageNew :: (HasCallStack, MonadIO m) => m UnixCredentialsMessage
- unixCredentialsMessageNewWithCredentials :: (HasCallStack, MonadIO m, IsCredentials a) => a -> m UnixCredentialsMessage
- data UnixCredentialsMessageCredentialsPropertyInfo
- constructUnixCredentialsMessageCredentials :: (IsUnixCredentialsMessage o, MonadIO m, IsCredentials a) => a -> m (GValueConstruct o)
- getUnixCredentialsMessageCredentials :: (MonadIO m, IsUnixCredentialsMessage o) => o -> m Credentials
- unixCredentialsMessageCredentials :: AttrLabelProxy "credentials"
Exported types
newtype UnixCredentialsMessage Source #
Memory-managed wrapper type.
Constructors
| UnixCredentialsMessage (ManagedPtr UnixCredentialsMessage) |
Instances
class (GObject o, IsDescendantOf UnixCredentialsMessage o) => IsUnixCredentialsMessage o Source #
Type class for types which can be safely cast to UnixCredentialsMessage, for instance with toUnixCredentialsMessage.
Instances
| (GObject o, IsDescendantOf UnixCredentialsMessage o) => IsUnixCredentialsMessage o Source # | |
Defined in GI.Gio.Objects.UnixCredentialsMessage | |
toUnixCredentialsMessage :: (MonadIO m, IsUnixCredentialsMessage o) => o -> m UnixCredentialsMessage Source #
Cast to UnixCredentialsMessage, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, serialize, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCredentials, getData, getLevel, getMsgType, getProperty, getQdata, getSize.
Setters
type family ResolveUnixCredentialsMessageMethod (t :: Symbol) o where ... Source #
Equations
getCredentials
data UnixCredentialsMessageGetCredentialsMethodInfo Source #
Instances
| (signature ~ m Credentials, MonadIO m, IsUnixCredentialsMessage a) => OverloadedMethod UnixCredentialsMessageGetCredentialsMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.UnixCredentialsMessage Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo UnixCredentialsMessageGetCredentialsMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.UnixCredentialsMessage Methods | |
unixCredentialsMessageGetCredentials Source #
Arguments
| :: (HasCallStack, MonadIO m, IsUnixCredentialsMessage a) | |
| => a |
|
| -> m Credentials | Returns: A |
Gets the credentials stored in message.
Since: 2.26
isSupported
unixCredentialsMessageIsSupported Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m Bool |
Checks if passing Credentials on a Socket is supported on this platform.
Since: 2.26
new
unixCredentialsMessageNew Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m UnixCredentialsMessage | Returns: a new |
Creates a new UnixCredentialsMessage with credentials matching the current processes.
Since: 2.26
newWithCredentials
unixCredentialsMessageNewWithCredentials Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCredentials a) | |
| => a |
|
| -> m UnixCredentialsMessage | Returns: a new |
Creates a new UnixCredentialsMessage holding credentials.
Since: 2.26
Properties
credentials
The credentials stored in the message.
Since: 2.26
data UnixCredentialsMessageCredentialsPropertyInfo Source #
Instances
constructUnixCredentialsMessageCredentials :: (IsUnixCredentialsMessage o, MonadIO m, IsCredentials a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “credentials” property. This is rarely needed directly, but it is used by new.
getUnixCredentialsMessageCredentials :: (MonadIO m, IsUnixCredentialsMessage o) => o -> m Credentials Source #
Get the value of the “credentials” property.
When overloading is enabled, this is equivalent to
get unixCredentialsMessage #credentials
unixCredentialsMessageCredentials :: AttrLabelProxy "credentials" Source #