GI.Gio.Objects.UnixCredentialsMessage

This SocketControlMessage contains a Credentials instance. It may be sent using socketSendMessage and received using socketReceiveMessage over UNIX sockets (ie: sockets in the SocketFamilyUnix 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: 2.26

Exported types

newtype UnixCredentialsMessage

Memory-managed wrapper type.

Constructors

UnixCredentialsMessage (ManagedPtr UnixCredentialsMessage)

Instances

GObject UnixCredentialsMessage

Defined in GI.Gio.Objects.UnixCredentialsMessage

Methods

gobjectType :: IO GType

HasParentTypes UnixCredentialsMessage

Defined in GI.Gio.Objects.UnixCredentialsMessage

type ParentTypes UnixCredentialsMessage

Defined in GI.Gio.Objects.UnixCredentialsMessage

type ParentTypes UnixCredentialsMessage = SocketControlMessage ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf UnixCredentialsMessage o) => IsUnixCredentialsMessage o

Type class for types which can be safely cast to UnixCredentialsMessage, for instance with toUnixCredentialsMessage.

Instances

(GObject o, IsDescendantOf UnixCredentialsMessage o) => IsUnixCredentialsMessage o

Defined in GI.Gio.Objects.UnixCredentialsMessage

toUnixCredentialsMessage :: (MonadIO m, IsUnixCredentialsMessage o) => o -> m UnixCredentialsMessage

Cast to UnixCredentialsMessage, for types for which this is known to be safe. For general casts, use castTo.

noUnixCredentialsMessage :: Maybe UnixCredentialsMessage

A convenience alias for Nothing :: Maybe UnixCredentialsMessage.

Methods

getCredentials

unixCredentialsMessageGetCredentials

Arguments

:: (HasCallStack, MonadIO m, IsUnixCredentialsMessage a)

=> a

message: A UnixCredentialsMessage.

-> m Credentials

Returns: A Credentials instance. Do not free, it is owned by message.

Gets the credentials stored in message.

Since: 2.26

isSupported

unixCredentialsMessageIsSupported

Arguments

:: (HasCallStack, MonadIO m)

=> m Bool

Returns: True if supported, False otherwise

Checks if passing Credentials on a Socket is supported on this platform.

Since: 2.26

new

unixCredentialsMessageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m UnixCredentialsMessage

Returns: a new UnixCredentialsMessage

Creates a new UnixCredentialsMessage with credentials matching the current processes.

Since: 2.26

newWithCredentials

unixCredentialsMessageNewWithCredentials

Arguments

:: (HasCallStack, MonadIO m, IsCredentials a)

=> a

credentials: A Credentials object.

-> m UnixCredentialsMessage

Returns: a new UnixCredentialsMessage

Creates a new UnixCredentialsMessage holding credentials.

Since: 2.26

Properties

credentials

The credentials stored in the message.

Since: 2.26

constructUnixCredentialsMessageCredentials :: (IsUnixCredentialsMessage o, IsCredentials a) => a -> IO (GValueConstruct o)

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

Get the value of the “credentials” property. When overloading is enabled, this is equivalent to

get unixCredentialsMessage #credentials