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

Constructors

SocketAddress (ManagedPtr SocketAddress)

Instances

GObject SocketAddress

Methods

gobjectType :: SocketAddress -> IO GType

IsObject SocketAddress

IsSocketAddress SocketAddress

IsSocketConnectable SocketAddress

((~) * info (ResolveSocketAddressMethod t SocketAddress), MethodInfo * info SocketAddress p) => IsLabel t (SocketAddress -> p)

Methods

fromLabel :: Proxy# Symbol t -> SocketAddress -> p

((~) * info (ResolveSocketAddressMethod t SocketAddress), MethodInfo * info SocketAddress p) => IsLabelProxy t (SocketAddress -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> SocketAddress -> p

HasAttributeList * SocketAddress

type AttributeList SocketAddress

type AttributeList SocketAddress

type SignalList SocketAddress

type SignalList SocketAddress

class GObject o => IsSocketAddress o

Instances

(GObject a, UnknownAncestorError Constraint SocketAddress a) => IsSocketAddress a

IsSocketAddress SocketAddress

IsSocketAddress ProxyAddress

IsSocketAddress InetSocketAddress

IsSocketAddress UnixSocketAddress

toSocketAddress :: IsSocketAddress o => o -> IO SocketAddress

noSocketAddress :: Maybe SocketAddress

Methods

getFamily

data SocketAddressGetFamilyMethodInfo

Instances

((~) * signature (m SocketFamily), MonadIO m, IsSocketAddress a) => MethodInfo * SocketAddressGetFamilyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketAddressGetFamilyMethodInfo a -> signature -> s

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

data SocketAddressGetNativeSizeMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsSocketAddress a) => MethodInfo * SocketAddressGetNativeSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketAddressGetNativeSizeMethodInfo a -> signature -> s

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

data SocketAddressToNativeMethodInfo

Instances

((~) * signature (Ptr () -> Word64 -> m ()), MonadIO m, IsSocketAddress a) => MethodInfo * SocketAddressToNativeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy SocketAddressToNativeMethodInfo a -> signature -> s

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

data SocketAddressFamilyPropertyInfo

Instances

AttrInfo SocketAddressFamilyPropertyInfo

Associated Types

type AttrAllowedOps SocketAddressFamilyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketAddressFamilyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo :: * -> Constraint

type AttrGetType SocketAddressFamilyPropertyInfo :: *

type AttrLabel SocketAddressFamilyPropertyInfo :: Symbol

type AttrOrigin SocketAddressFamilyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo o => Proxy * SocketAddressFamilyPropertyInfo -> o -> IO (AttrGetType SocketAddressFamilyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo o, AttrSetTypeConstraint SocketAddressFamilyPropertyInfo b) => Proxy * SocketAddressFamilyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo o => Proxy * SocketAddressFamilyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo o, AttrSetTypeConstraint SocketAddressFamilyPropertyInfo b) => Proxy * SocketAddressFamilyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin SocketAddressFamilyPropertyInfo

type AttrOrigin SocketAddressFamilyPropertyInfo = SocketAddress

type AttrLabel SocketAddressFamilyPropertyInfo

type AttrLabel SocketAddressFamilyPropertyInfo = "family"

type AttrGetType SocketAddressFamilyPropertyInfo

type AttrGetType SocketAddressFamilyPropertyInfo = SocketFamily

type AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo

type AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo = IsSocketAddress

type AttrSetTypeConstraint SocketAddressFamilyPropertyInfo

type AttrSetTypeConstraint SocketAddressFamilyPropertyInfo = * ~ ()

type AttrAllowedOps SocketAddressFamilyPropertyInfo

type AttrAllowedOps SocketAddressFamilyPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

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

socketAddressFamily :: AttrLabelProxy "family"