| 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.SocketAddress
Description
GSocketAddress is the equivalent of
`struct sockaddr`) and its subtypes in the BSD sockets
API. This is an abstract class; use InetSocketAddress for
internet sockets, or UnixSocketAddress for UNIX domain sockets.
Synopsis
- newtype SocketAddress = SocketAddress (ManagedPtr SocketAddress)
- class (GObject o, IsDescendantOf SocketAddress o) => IsSocketAddress o
- toSocketAddress :: (MonadIO m, IsSocketAddress o) => o -> m SocketAddress
- type family ResolveSocketAddressMethod (t :: Symbol) o where ...
- data SocketAddressGetFamilyMethodInfo
- socketAddressGetFamily :: (HasCallStack, MonadIO m, IsSocketAddress a) => a -> m SocketFamily
- data SocketAddressGetNativeSizeMethodInfo
- socketAddressGetNativeSize :: (HasCallStack, MonadIO m, IsSocketAddress a) => a -> m Int64
- socketAddressNewFromNative :: (HasCallStack, MonadIO m) => Ptr () -> CSize -> m SocketAddress
- data SocketAddressToNativeMethodInfo
- socketAddressToNative :: (HasCallStack, MonadIO m, IsSocketAddress a) => a -> Ptr () -> CSize -> m ()
- data SocketAddressFamilyPropertyInfo
- getSocketAddressFamily :: (MonadIO m, IsSocketAddress o) => o -> m SocketFamily
- socketAddressFamily :: AttrLabelProxy "family"
Exported types
newtype SocketAddress Source #
Memory-managed wrapper type.
Constructors
| SocketAddress (ManagedPtr SocketAddress) |
Instances
class (GObject o, IsDescendantOf SocketAddress o) => IsSocketAddress o Source #
Type class for types which can be safely cast to SocketAddress, for instance with toSocketAddress.
Instances
| (GObject o, IsDescendantOf SocketAddress o) => IsSocketAddress o Source # | |
Defined in GI.Gio.Objects.SocketAddress | |
toSocketAddress :: (MonadIO m, IsSocketAddress o) => o -> m SocketAddress Source #
Cast to SocketAddress, 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, enumerate, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, proxyEnumerate, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toNative, toString, unref, watchClosure.
Getters
getData, getFamily, getNativeSize, getProperty, getQdata.
Setters
type family ResolveSocketAddressMethod (t :: Symbol) o where ... Source #
Equations
getFamily
data SocketAddressGetFamilyMethodInfo Source #
Instances
| (signature ~ m SocketFamily, MonadIO m, IsSocketAddress a) => OverloadedMethod SocketAddressGetFamilyMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo SocketAddressGetFamilyMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods | |
socketAddressGetFamily Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSocketAddress a) | |
| => a |
|
| -> m SocketFamily | Returns: the socket family type of |
Gets the socket family type of address.
Since: 2.22
getNativeSize
data SocketAddressGetNativeSizeMethodInfo Source #
Instances
| (signature ~ m Int64, MonadIO m, IsSocketAddress a) => OverloadedMethod SocketAddressGetNativeSizeMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo SocketAddressGetNativeSizeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods | |
socketAddressGetNativeSize Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSocketAddress a) | |
| => a |
|
| -> m Int64 | Returns: the size of the native struct sockaddr that
|
Gets the size of address's native struct sockaddr.
You can use this to allocate memory to pass to
socketAddressToNative.
Since: 2.22
newFromNative
socketAddressNewFromNative Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => Ptr () |
|
| -> CSize |
|
| -> m SocketAddress | Returns: a new |
Creates a SocketAddress subclass corresponding to the native
struct sockaddr native.
Since: 2.22
toNative
data SocketAddressToNativeMethodInfo Source #
Instances
| (signature ~ (Ptr () -> CSize -> m ()), MonadIO m, IsSocketAddress a) => OverloadedMethod SocketAddressToNativeMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo SocketAddressToNativeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.SocketAddress Methods | |
socketAddressToNative Source #
Arguments
| :: (HasCallStack, MonadIO m, IsSocketAddress a) | |
| => a |
|
| -> Ptr () |
|
| -> CSize |
|
| -> m () | (Can throw |
Converts a SocketAddress to a native struct sockaddr, which can
be passed to low-level functions like connect() or bind().
If not enough space is available, a IOErrorEnumNoSpace error
is returned. If the address type is not known on the system
then a IOErrorEnumNotSupported error is returned.
Since: 2.22
Properties
family
The family of the socket address.
Since: 2.22
data SocketAddressFamilyPropertyInfo Source #
Instances
getSocketAddressFamily :: (MonadIO m, IsSocketAddress o) => o -> m SocketFamily Source #
Get the value of the “family” property.
When overloading is enabled, this is equivalent to
get socketAddress #family
socketAddressFamily :: AttrLabelProxy "family" Source #