{- | Copyright : Will Thompson, Iñaki García Etxebarria and Jonas Platte License : LGPL-2.1 Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc) 'GI.Gio.Objects.SocketAddress.SocketAddress' is the equivalent of struct sockaddr in the BSD sockets API. This is an abstract class; use 'GI.Gio.Objects.InetSocketAddress.InetSocketAddress' for internet sockets, or 'GI.Gio.Objects.UnixSocketAddress.UnixSocketAddress' for UNIX domain sockets. -} #define ENABLE_OVERLOADING (MIN_VERSION_haskell_gi_overloading(1,0,0) \ && !defined(__HADDOCK_VERSION__)) module GI.Gio.Objects.SocketAddress ( -- * Exported types SocketAddress(..) , IsSocketAddress , toSocketAddress , noSocketAddress , -- * Methods -- ** getFamily #method:getFamily# #if ENABLE_OVERLOADING SocketAddressGetFamilyMethodInfo , #endif socketAddressGetFamily , -- ** getNativeSize #method:getNativeSize# #if ENABLE_OVERLOADING SocketAddressGetNativeSizeMethodInfo , #endif socketAddressGetNativeSize , -- ** newFromNative #method:newFromNative# socketAddressNewFromNative , -- ** toNative #method:toNative# #if ENABLE_OVERLOADING SocketAddressToNativeMethodInfo , #endif socketAddressToNative , -- * Properties -- ** family #attr:family# {- | /No description available in the introspection data./ -} #if ENABLE_OVERLOADING SocketAddressFamilyPropertyInfo , #endif getSocketAddressFamily , #if ENABLE_OVERLOADING socketAddressFamily , #endif ) where import Data.GI.Base.ShortPrelude import qualified Data.GI.Base.ShortPrelude as SP import qualified Data.GI.Base.Overloading as O import qualified Prelude as P import qualified Data.GI.Base.Attributes as GI.Attributes import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr import qualified Data.GI.Base.GClosure as B.GClosure import qualified Data.GI.Base.GError as B.GError import qualified Data.GI.Base.GVariant as B.GVariant import qualified Data.GI.Base.GValue as B.GValue import qualified Data.GI.Base.GParamSpec as B.GParamSpec import qualified Data.GI.Base.CallStack as B.CallStack import qualified Data.GI.Base.Properties as B.Properties import qualified Data.Text as T import qualified Data.ByteString.Char8 as B import qualified Data.Map as Map import qualified Foreign.Ptr as FP import qualified GHC.OverloadedLabels as OL import qualified GI.GObject.Objects.Object as GObject.Object import {-# SOURCE #-} qualified GI.Gio.Enums as Gio.Enums import {-# SOURCE #-} qualified GI.Gio.Interfaces.SocketConnectable as Gio.SocketConnectable -- | Memory-managed wrapper type. newtype SocketAddress = SocketAddress (ManagedPtr SocketAddress) foreign import ccall "g_socket_address_get_type" c_g_socket_address_get_type :: IO GType instance GObject SocketAddress where gobjectType = c_g_socket_address_get_type -- | Type class for types which can be safely cast to `SocketAddress`, for instance with `toSocketAddress`. class (GObject o, O.IsDescendantOf SocketAddress o) => IsSocketAddress o instance (GObject o, O.IsDescendantOf SocketAddress o) => IsSocketAddress o instance O.HasParentTypes SocketAddress type instance O.ParentTypes SocketAddress = '[GObject.Object.Object, Gio.SocketConnectable.SocketConnectable] -- | Cast to `SocketAddress`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`. toSocketAddress :: (MonadIO m, IsSocketAddress o) => o -> m SocketAddress toSocketAddress = liftIO . unsafeCastTo SocketAddress -- | A convenience alias for `Nothing` :: `Maybe` `SocketAddress`. noSocketAddress :: Maybe SocketAddress noSocketAddress = Nothing #if ENABLE_OVERLOADING type family ResolveSocketAddressMethod (t :: Symbol) (o :: *) :: * where ResolveSocketAddressMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo ResolveSocketAddressMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo ResolveSocketAddressMethod "enumerate" o = Gio.SocketConnectable.SocketConnectableEnumerateMethodInfo ResolveSocketAddressMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo ResolveSocketAddressMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo ResolveSocketAddressMethod "getv" o = GObject.Object.ObjectGetvMethodInfo ResolveSocketAddressMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo ResolveSocketAddressMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo ResolveSocketAddressMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo ResolveSocketAddressMethod "proxyEnumerate" o = Gio.SocketConnectable.SocketConnectableProxyEnumerateMethodInfo ResolveSocketAddressMethod "ref" o = GObject.Object.ObjectRefMethodInfo ResolveSocketAddressMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo ResolveSocketAddressMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo ResolveSocketAddressMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo ResolveSocketAddressMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo ResolveSocketAddressMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo ResolveSocketAddressMethod "toNative" o = SocketAddressToNativeMethodInfo ResolveSocketAddressMethod "toString" o = Gio.SocketConnectable.SocketConnectableToStringMethodInfo ResolveSocketAddressMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo ResolveSocketAddressMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo ResolveSocketAddressMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo ResolveSocketAddressMethod "getFamily" o = SocketAddressGetFamilyMethodInfo ResolveSocketAddressMethod "getNativeSize" o = SocketAddressGetNativeSizeMethodInfo ResolveSocketAddressMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo ResolveSocketAddressMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo ResolveSocketAddressMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo ResolveSocketAddressMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo ResolveSocketAddressMethod l o = O.MethodResolutionFailed l o instance (info ~ ResolveSocketAddressMethod t SocketAddress, O.MethodInfo info SocketAddress p) => OL.IsLabel t (SocketAddress -> p) where #if MIN_VERSION_base(4,10,0) fromLabel = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info) #else fromLabel _ = O.overloadedMethod (O.MethodProxy :: O.MethodProxy info) #endif #endif -- VVV Prop "family" -- Type: TInterface (Name {namespace = "Gio", name = "SocketFamily"}) -- Flags: [PropertyReadable] -- Nullable: (Just False,Nothing) {- | Get the value of the “@family@” property. When is enabled, this is equivalent to @ 'Data.GI.Base.Attributes.get' socketAddress #family @ -} getSocketAddressFamily :: (MonadIO m, IsSocketAddress o) => o -> m Gio.Enums.SocketFamily getSocketAddressFamily obj = liftIO $ B.Properties.getObjectPropertyEnum obj "family" #if ENABLE_OVERLOADING data SocketAddressFamilyPropertyInfo instance AttrInfo SocketAddressFamilyPropertyInfo where type AttrAllowedOps SocketAddressFamilyPropertyInfo = '[ 'AttrGet] type AttrSetTypeConstraint SocketAddressFamilyPropertyInfo = (~) () type AttrBaseTypeConstraint SocketAddressFamilyPropertyInfo = IsSocketAddress type AttrGetType SocketAddressFamilyPropertyInfo = Gio.Enums.SocketFamily type AttrLabel SocketAddressFamilyPropertyInfo = "family" type AttrOrigin SocketAddressFamilyPropertyInfo = SocketAddress attrGet _ = getSocketAddressFamily attrSet _ = undefined attrConstruct _ = undefined attrClear _ = undefined #endif #if ENABLE_OVERLOADING instance O.HasAttributeList SocketAddress type instance O.AttributeList SocketAddress = SocketAddressAttributeList type SocketAddressAttributeList = ('[ '("family", SocketAddressFamilyPropertyInfo)] :: [(Symbol, *)]) #endif #if ENABLE_OVERLOADING socketAddressFamily :: AttrLabelProxy "family" socketAddressFamily = AttrLabelProxy #endif #if ENABLE_OVERLOADING type instance O.SignalList SocketAddress = SocketAddressSignalList type SocketAddressSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)]) #endif -- method SocketAddress::new_from_native -- method type : Constructor -- Args : [Arg {argCName = "native", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a pointer to a struct sockaddr", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "len", argType = TBasicType TUInt64, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the size of the memory location pointed to by @native", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}] -- Lengths : [] -- returnType : Just (TInterface (Name {namespace = "Gio", name = "SocketAddress"})) -- throws : False -- Skip return : False foreign import ccall "g_socket_address_new_from_native" g_socket_address_new_from_native :: Ptr () -> -- native : TBasicType TPtr Word64 -> -- len : TBasicType TUInt64 IO (Ptr SocketAddress) {- | Creates a 'GI.Gio.Objects.SocketAddress.SocketAddress' subclass corresponding to the native struct sockaddr /@native@/. /Since: 2.22/ -} socketAddressNewFromNative :: (B.CallStack.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 'GI.Gio.Objects.SocketAddress.SocketAddress' if /@native@/ could successfully be converted, otherwise 'Nothing' -} socketAddressNewFromNative native len = liftIO $ do result <- g_socket_address_new_from_native native len checkUnexpectedReturnNULL "socketAddressNewFromNative" result result' <- (wrapObject SocketAddress) result return result' #if ENABLE_OVERLOADING #endif -- method SocketAddress::get_family -- method type : OrdinaryMethod -- Args : [Arg {argCName = "address", argType = TInterface (Name {namespace = "Gio", name = "SocketAddress"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GSocketAddress", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}] -- Lengths : [] -- returnType : Just (TInterface (Name {namespace = "Gio", name = "SocketFamily"})) -- throws : False -- Skip return : False foreign import ccall "g_socket_address_get_family" g_socket_address_get_family :: Ptr SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) IO CUInt {- | Gets the socket family type of /@address@/. /Since: 2.22/ -} socketAddressGetFamily :: (B.CallStack.HasCallStack, MonadIO m, IsSocketAddress a) => a {- ^ /@address@/: a 'GI.Gio.Objects.SocketAddress.SocketAddress' -} -> m Gio.Enums.SocketFamily {- ^ __Returns:__ the socket family type of /@address@/ -} socketAddressGetFamily address = liftIO $ do address' <- unsafeManagedPtrCastPtr address result <- g_socket_address_get_family address' let result' = (toEnum . fromIntegral) result touchManagedPtr address return result' #if ENABLE_OVERLOADING data SocketAddressGetFamilyMethodInfo instance (signature ~ (m Gio.Enums.SocketFamily), MonadIO m, IsSocketAddress a) => O.MethodInfo SocketAddressGetFamilyMethodInfo a signature where overloadedMethod _ = socketAddressGetFamily #endif -- method SocketAddress::get_native_size -- method type : OrdinaryMethod -- Args : [Arg {argCName = "address", argType = TInterface (Name {namespace = "Gio", name = "SocketAddress"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GSocketAddress", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}] -- Lengths : [] -- returnType : Just (TBasicType TInt64) -- throws : False -- Skip return : False foreign import ccall "g_socket_address_get_native_size" g_socket_address_get_native_size :: Ptr SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) IO Int64 {- | Gets the size of /@address@/\'s native struct sockaddr. You can use this to allocate memory to pass to 'GI.Gio.Objects.SocketAddress.socketAddressToNative'. /Since: 2.22/ -} socketAddressGetNativeSize :: (B.CallStack.HasCallStack, MonadIO m, IsSocketAddress a) => a {- ^ /@address@/: a 'GI.Gio.Objects.SocketAddress.SocketAddress' -} -> m Int64 {- ^ __Returns:__ the size of the native struct sockaddr that /@address@/ represents -} socketAddressGetNativeSize address = liftIO $ do address' <- unsafeManagedPtrCastPtr address result <- g_socket_address_get_native_size address' touchManagedPtr address return result #if ENABLE_OVERLOADING data SocketAddressGetNativeSizeMethodInfo instance (signature ~ (m Int64), MonadIO m, IsSocketAddress a) => O.MethodInfo SocketAddressGetNativeSizeMethodInfo a signature where overloadedMethod _ = socketAddressGetNativeSize #endif -- method SocketAddress::to_native -- method type : OrdinaryMethod -- Args : [Arg {argCName = "address", argType = TInterface (Name {namespace = "Gio", name = "SocketAddress"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GSocketAddress", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "dest", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "a pointer to a memory location that will contain the native\nstruct sockaddr", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "destlen", argType = TBasicType TUInt64, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the size of @dest. Must be at least as large as\n g_socket_address_get_native_size()", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}] -- Lengths : [] -- returnType : Just (TBasicType TBoolean) -- throws : True -- Skip return : False foreign import ccall "g_socket_address_to_native" g_socket_address_to_native :: Ptr SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr () -> -- dest : TBasicType TPtr Word64 -> -- destlen : TBasicType TUInt64 Ptr (Ptr GError) -> -- error IO CInt {- | Converts a 'GI.Gio.Objects.SocketAddress.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 'GI.Gio.Enums.IOErrorEnumNoSpace' error is returned. If the address type is not known on the system then a 'GI.Gio.Enums.IOErrorEnumNotSupported' error is returned. /Since: 2.22/ -} socketAddressToNative :: (B.CallStack.HasCallStack, MonadIO m, IsSocketAddress a) => a {- ^ /@address@/: a 'GI.Gio.Objects.SocketAddress.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 'GI.Gio.Objects.SocketAddress.socketAddressGetNativeSize' -} -> m () {- ^ /(Can throw 'Data.GI.Base.GError.GError')/ -} socketAddressToNative address dest destlen = liftIO $ do address' <- unsafeManagedPtrCastPtr address onException (do _ <- propagateGError $ g_socket_address_to_native address' dest destlen touchManagedPtr address return () ) (do return () ) #if ENABLE_OVERLOADING data SocketAddressToNativeMethodInfo instance (signature ~ (Ptr () -> Word64 -> m ()), MonadIO m, IsSocketAddress a) => O.MethodInfo SocketAddressToNativeMethodInfo a signature where overloadedMethod _ = socketAddressToNative #endif