GI.Gio.Objects.SocketAddress

SocketAddress is the equivalent of struct sockaddr in the BSD sockets API. This is an abstract class; use InetSocketAddress for internet sockets, or UnixSocketAddress for UNIX domain sockets.

Exported types

newtype SocketAddress

Memory-managed wrapper type.

Constructors

SocketAddress (ManagedPtr SocketAddress)

Instances

Eq SocketAddress

Defined in GI.Gio.Objects.SocketAddress

Methods

(==) :: SocketAddress -> SocketAddress -> Bool

(/=) :: SocketAddress -> SocketAddress -> Bool

GObject SocketAddress

Defined in GI.Gio.Objects.SocketAddress

ManagedPtrNewtype SocketAddress

Defined in GI.Gio.Objects.SocketAddress

Methods

toManagedPtr :: SocketAddress -> ManagedPtr SocketAddress

TypedObject SocketAddress

Defined in GI.Gio.Objects.SocketAddress

Methods

glibType :: IO GType

HasParentTypes SocketAddress

Defined in GI.Gio.Objects.SocketAddress

IsGValue (Maybe SocketAddress)

Convert SocketAddress to and from GValue. See toGValue and fromGValue.

Defined in GI.Gio.Objects.SocketAddress

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SocketAddress -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SocketAddress)

type ParentTypes SocketAddress

Defined in GI.Gio.Objects.SocketAddress

type ParentTypes SocketAddress = '[Object, SocketConnectable]

class (GObject o, IsDescendantOf SocketAddress o) => IsSocketAddress o

Type class for types which can be safely cast to SocketAddress, for instance with toSocketAddress.

Instances

(GObject o, IsDescendantOf SocketAddress o) => IsSocketAddress o

Defined in GI.Gio.Objects.SocketAddress

toSocketAddress :: (MonadIO m, IsSocketAddress o) => o -> m SocketAddress

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

setData, setDataFull, setProperty.

getFamily

socketAddressGetFamily

Arguments

:: (HasCallStack, MonadIO m, IsSocketAddress a)

=> a

address: a SocketAddress

-> m SocketFamily

Returns: the socket family type of address

Gets the socket family type of address.

Since: 2.22

getNativeSize

socketAddressGetNativeSize

Arguments

:: (HasCallStack, MonadIO m, IsSocketAddress a)

=> a

address: a SocketAddress

-> m Int64

Returns: the size of the native struct sockaddr that address represents

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

Arguments

:: (HasCallStack, MonadIO m)

=> Ptr ()

native: a pointer to a struct sockaddr

-> Word64

len: the size of the memory location pointed to by native

-> m SocketAddress

Returns: a new SocketAddress if native could successfully be converted, otherwise Nothing

Creates a SocketAddress subclass corresponding to the native struct sockaddr native.

Since: 2.22

toNative

socketAddressToNative

Arguments

:: (HasCallStack, MonadIO m, IsSocketAddress a)

=> a

address: a SocketAddress

-> Ptr ()

dest: a pointer to a memory location that will contain the native struct sockaddr

-> Word64

destlen: the size of dest. Must be at least as large as socketAddressGetNativeSize

-> m ()

(Can throw GError)

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

No description available in the introspection data.

getSocketAddressFamily :: (MonadIO m, IsSocketAddress o) => o -> m SocketFamily

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

get socketAddress #family