{-# LANGUAGE TypeApplications #-} -- | Copyright : Will Thompson and Iñaki García Etxebarria -- License : LGPL-2.1 -- Maintainer : Iñaki García Etxebarria -- -- Interface for socket-like objects with datagram semantics. -- -- A @GDatagramBased@ is a networking interface for representing datagram-based -- communications. It is a more or less direct mapping of the core parts of the -- BSD socket API in a portable GObject interface. It is implemented by -- t'GI.Gio.Objects.Socket.Socket', which wraps the UNIX socket API on UNIX and winsock2 on Windows. -- -- @GDatagramBased@ is entirely platform independent, and is intended to be used -- alongside higher-level networking APIs such as t'GI.Gio.Objects.IOStream.IOStream'. -- -- It uses vectored scatter\/gather I\/O by default, allowing for many messages -- to be sent or received in a single call. Where possible, implementations of -- the interface should take advantage of vectored I\/O to minimise processing -- or system calls. For example, @GSocket@ uses @recvmmsg()@ and @sendmmsg()@ -- where possible. Callers should take advantage of scatter\/gather I\/O (the use of -- multiple buffers per message) to avoid unnecessary copying of data to -- assemble or disassemble a message. -- -- Each @GDatagramBased@ operation has a timeout parameter which may be negative -- for blocking behaviour, zero for non-blocking behaviour, or positive for -- timeout behaviour. A blocking operation blocks until finished or there is an -- error. A non-blocking operation will return immediately with a -- @G_IO_ERROR_WOULD_BLOCK@ error if it cannot make progress. A timeout operation -- will block until the operation is complete or the timeout expires; if the -- timeout expires it will return what progress it made, or -- @G_IO_ERROR_TIMED_OUT@ if no progress was made. To know when a call would -- successfully run you can call 'GI.Gio.Interfaces.DatagramBased.datagramBasedConditionCheck' or -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedConditionWait'. You can also use -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedCreateSource' and attach it to a [struct/@gLib@/.MainContext] -- to get callbacks when I\/O is possible. -- -- When running a non-blocking operation applications should always be able to -- handle getting a @G_IO_ERROR_WOULD_BLOCK@ error even when some other function -- said that I\/O was possible. This can easily happen in case of a race -- condition in the application, but it can also happen for other reasons. For -- instance, on Windows a socket is always seen as writable until a write -- returns @G_IO_ERROR_WOULD_BLOCK@. -- -- As with @GSocket@, @GDatagramBased@s can be either connection oriented (for -- example, SCTP) or connectionless (for example, UDP). @GDatagramBased@s must be -- datagram-based, not stream-based. The interface does not cover connection -- establishment — use methods on the underlying type to establish a connection -- before sending and receiving data through the @GDatagramBased@ API. For -- connectionless socket types the target\/source address is specified or -- received in each I\/O operation. -- -- Like most other APIs in GLib, @GDatagramBased@ is not inherently thread safe. -- To use a @GDatagramBased@ concurrently from multiple threads, you must -- implement your own locking. -- -- /Since: 2.48/ #if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__)) #define ENABLE_OVERLOADING #endif module GI.Gio.Interfaces.DatagramBased ( -- * Exported types DatagramBased(..) , IsDatagramBased , toDatagramBased , -- * Methods -- | -- -- === __Click to display all available methods, including inherited ones__ -- ==== Methods -- [bindProperty]("GI.GObject.Objects.Object#g:method:bindProperty"), [bindPropertyFull]("GI.GObject.Objects.Object#g:method:bindPropertyFull"), [conditionCheck]("GI.Gio.Interfaces.DatagramBased#g:method:conditionCheck"), [conditionWait]("GI.Gio.Interfaces.DatagramBased#g:method:conditionWait"), [createSource]("GI.Gio.Interfaces.DatagramBased#g:method:createSource"), [forceFloating]("GI.GObject.Objects.Object#g:method:forceFloating"), [freezeNotify]("GI.GObject.Objects.Object#g:method:freezeNotify"), [getv]("GI.GObject.Objects.Object#g:method:getv"), [isFloating]("GI.GObject.Objects.Object#g:method:isFloating"), [notify]("GI.GObject.Objects.Object#g:method:notify"), [notifyByPspec]("GI.GObject.Objects.Object#g:method:notifyByPspec"), [receiveMessages]("GI.Gio.Interfaces.DatagramBased#g:method:receiveMessages"), [ref]("GI.GObject.Objects.Object#g:method:ref"), [refSink]("GI.GObject.Objects.Object#g:method:refSink"), [runDispose]("GI.GObject.Objects.Object#g:method:runDispose"), [sendMessages]("GI.Gio.Interfaces.DatagramBased#g:method:sendMessages"), [stealData]("GI.GObject.Objects.Object#g:method:stealData"), [stealQdata]("GI.GObject.Objects.Object#g:method:stealQdata"), [thawNotify]("GI.GObject.Objects.Object#g:method:thawNotify"), [unref]("GI.GObject.Objects.Object#g:method:unref"), [watchClosure]("GI.GObject.Objects.Object#g:method:watchClosure"). -- -- ==== Getters -- [getData]("GI.GObject.Objects.Object#g:method:getData"), [getProperty]("GI.GObject.Objects.Object#g:method:getProperty"), [getQdata]("GI.GObject.Objects.Object#g:method:getQdata"). -- -- ==== Setters -- [setData]("GI.GObject.Objects.Object#g:method:setData"), [setDataFull]("GI.GObject.Objects.Object#g:method:setDataFull"), [setProperty]("GI.GObject.Objects.Object#g:method:setProperty"). #if defined(ENABLE_OVERLOADING) ResolveDatagramBasedMethod , #endif -- ** conditionCheck #method:conditionCheck# #if defined(ENABLE_OVERLOADING) DatagramBasedConditionCheckMethodInfo , #endif datagramBasedConditionCheck , -- ** conditionWait #method:conditionWait# #if defined(ENABLE_OVERLOADING) DatagramBasedConditionWaitMethodInfo , #endif datagramBasedConditionWait , -- ** createSource #method:createSource# #if defined(ENABLE_OVERLOADING) DatagramBasedCreateSourceMethodInfo , #endif datagramBasedCreateSource , -- ** receiveMessages #method:receiveMessages# #if defined(ENABLE_OVERLOADING) DatagramBasedReceiveMessagesMethodInfo , #endif datagramBasedReceiveMessages , -- ** sendMessages #method:sendMessages# #if defined(ENABLE_OVERLOADING) DatagramBasedSendMessagesMethodInfo , #endif datagramBasedSendMessages , ) 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.BasicTypes as B.Types import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr import qualified Data.GI.Base.GArray as B.GArray import qualified Data.GI.Base.GClosure as B.GClosure import qualified Data.GI.Base.GError as B.GError import qualified Data.GI.Base.GHashTable as B.GHT 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.GI.Base.Signals as B.Signals import qualified Control.Monad.IO.Class as MIO import qualified Data.Coerce as Coerce import qualified Data.Text as T import qualified Data.Kind as DK 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 GHC.Records as R import qualified Data.Word as DW import qualified Data.Int as DI import qualified System.Posix.Types as SPT import qualified Foreign.C.Types as FCT -- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/23392 #if MIN_VERSION_base(4,18,0) import qualified GI.GLib.Callbacks as GLib.Callbacks import qualified GI.GLib.Flags as GLib.Flags import qualified GI.GLib.Structs.PollFD as GLib.PollFD import qualified GI.GLib.Structs.Source as GLib.Source import qualified GI.GObject.Callbacks as GObject.Callbacks import qualified GI.GObject.Objects.Object as GObject.Object import qualified GI.Gio.Callbacks as Gio.Callbacks import {-# SOURCE #-} qualified GI.Gio.Enums as Gio.Enums import {-# SOURCE #-} qualified GI.Gio.Interfaces.AsyncResult as Gio.AsyncResult import {-# SOURCE #-} qualified GI.Gio.Interfaces.SocketConnectable as Gio.SocketConnectable import {-# SOURCE #-} qualified GI.Gio.Objects.Cancellable as Gio.Cancellable import {-# SOURCE #-} qualified GI.Gio.Objects.SocketAddress as Gio.SocketAddress import {-# SOURCE #-} qualified GI.Gio.Objects.SocketAddressEnumerator as Gio.SocketAddressEnumerator import {-# SOURCE #-} qualified GI.Gio.Structs.InputMessage as Gio.InputMessage import {-# SOURCE #-} qualified GI.Gio.Structs.OutputMessage as Gio.OutputMessage import {-# SOURCE #-} qualified GI.Gio.Structs.OutputVector as Gio.OutputVector #else import qualified GI.GLib.Flags as GLib.Flags import qualified GI.GLib.Structs.Source as GLib.Source import qualified GI.GObject.Objects.Object as GObject.Object import {-# SOURCE #-} qualified GI.Gio.Objects.Cancellable as Gio.Cancellable import {-# SOURCE #-} qualified GI.Gio.Structs.InputMessage as Gio.InputMessage import {-# SOURCE #-} qualified GI.Gio.Structs.OutputMessage as Gio.OutputMessage #endif -- interface DatagramBased -- | Memory-managed wrapper type. newtype DatagramBased = DatagramBased (SP.ManagedPtr DatagramBased) deriving (DatagramBased -> DatagramBased -> Bool (DatagramBased -> DatagramBased -> Bool) -> (DatagramBased -> DatagramBased -> Bool) -> Eq DatagramBased forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a $c== :: DatagramBased -> DatagramBased -> Bool == :: DatagramBased -> DatagramBased -> Bool $c/= :: DatagramBased -> DatagramBased -> Bool /= :: DatagramBased -> DatagramBased -> Bool Eq) instance SP.ManagedPtrNewtype DatagramBased where toManagedPtr :: DatagramBased -> ManagedPtr DatagramBased toManagedPtr (DatagramBased ManagedPtr DatagramBased p) = ManagedPtr DatagramBased p foreign import ccall "g_datagram_based_get_type" c_g_datagram_based_get_type :: IO B.Types.GType instance B.Types.TypedObject DatagramBased where glibType :: IO GType glibType = IO GType c_g_datagram_based_get_type instance B.Types.GObject DatagramBased -- | Type class for types which can be safely cast to `DatagramBased`, for instance with `toDatagramBased`. class (SP.GObject o, O.IsDescendantOf DatagramBased o) => IsDatagramBased o instance (SP.GObject o, O.IsDescendantOf DatagramBased o) => IsDatagramBased o instance O.HasParentTypes DatagramBased type instance O.ParentTypes DatagramBased = '[GObject.Object.Object] -- | Cast to `DatagramBased`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`. toDatagramBased :: (MIO.MonadIO m, IsDatagramBased o) => o -> m DatagramBased toDatagramBased :: forall (m :: * -> *) o. (MonadIO m, IsDatagramBased o) => o -> m DatagramBased toDatagramBased = IO DatagramBased -> m DatagramBased forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a MIO.liftIO (IO DatagramBased -> m DatagramBased) -> (o -> IO DatagramBased) -> o -> m DatagramBased forall b c a. (b -> c) -> (a -> b) -> a -> c . (ManagedPtr DatagramBased -> DatagramBased) -> o -> IO DatagramBased forall o o'. (HasCallStack, ManagedPtrNewtype o, TypedObject o, ManagedPtrNewtype o', TypedObject o') => (ManagedPtr o' -> o') -> o -> IO o' B.ManagedPtr.unsafeCastTo ManagedPtr DatagramBased -> DatagramBased DatagramBased -- | Convert 'DatagramBased' to and from 'Data.GI.Base.GValue.GValue'. See 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'. instance B.GValue.IsGValue (Maybe DatagramBased) where gvalueGType_ :: IO GType gvalueGType_ = IO GType c_g_datagram_based_get_type gvalueSet_ :: Ptr GValue -> Maybe DatagramBased -> IO () gvalueSet_ Ptr GValue gv Maybe DatagramBased P.Nothing = Ptr GValue -> Ptr DatagramBased -> IO () forall a. GObject a => Ptr GValue -> Ptr a -> IO () B.GValue.set_object Ptr GValue gv (Ptr DatagramBased forall a. Ptr a FP.nullPtr :: FP.Ptr DatagramBased) gvalueSet_ Ptr GValue gv (P.Just DatagramBased obj) = DatagramBased -> (Ptr DatagramBased -> IO ()) -> IO () forall a c. (HasCallStack, ManagedPtrNewtype a) => a -> (Ptr a -> IO c) -> IO c B.ManagedPtr.withManagedPtr DatagramBased obj (Ptr GValue -> Ptr DatagramBased -> IO () forall a. GObject a => Ptr GValue -> Ptr a -> IO () B.GValue.set_object Ptr GValue gv) gvalueGet_ :: Ptr GValue -> IO (Maybe DatagramBased) gvalueGet_ Ptr GValue gv = do ptr <- Ptr GValue -> IO (Ptr DatagramBased) forall a. GObject a => Ptr GValue -> IO (Ptr a) B.GValue.get_object Ptr GValue gv :: IO (FP.Ptr DatagramBased) if ptr /= FP.nullPtr then P.Just <$> B.ManagedPtr.newObject DatagramBased ptr else return P.Nothing #if defined(ENABLE_OVERLOADING) instance O.HasAttributeList DatagramBased type instance O.AttributeList DatagramBased = DatagramBasedAttributeList type DatagramBasedAttributeList = ('[ ] :: [(Symbol, DK.Type)]) #endif #if defined(ENABLE_OVERLOADING) #endif #if defined(ENABLE_OVERLOADING) type family ResolveDatagramBasedMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where ResolveDatagramBasedMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo ResolveDatagramBasedMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo ResolveDatagramBasedMethod "conditionCheck" o = DatagramBasedConditionCheckMethodInfo ResolveDatagramBasedMethod "conditionWait" o = DatagramBasedConditionWaitMethodInfo ResolveDatagramBasedMethod "createSource" o = DatagramBasedCreateSourceMethodInfo ResolveDatagramBasedMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo ResolveDatagramBasedMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo ResolveDatagramBasedMethod "getv" o = GObject.Object.ObjectGetvMethodInfo ResolveDatagramBasedMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo ResolveDatagramBasedMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo ResolveDatagramBasedMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo ResolveDatagramBasedMethod "receiveMessages" o = DatagramBasedReceiveMessagesMethodInfo ResolveDatagramBasedMethod "ref" o = GObject.Object.ObjectRefMethodInfo ResolveDatagramBasedMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo ResolveDatagramBasedMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo ResolveDatagramBasedMethod "sendMessages" o = DatagramBasedSendMessagesMethodInfo ResolveDatagramBasedMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo ResolveDatagramBasedMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo ResolveDatagramBasedMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo ResolveDatagramBasedMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo ResolveDatagramBasedMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo ResolveDatagramBasedMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo ResolveDatagramBasedMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo ResolveDatagramBasedMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo ResolveDatagramBasedMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo ResolveDatagramBasedMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo ResolveDatagramBasedMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo ResolveDatagramBasedMethod l o = O.MethodResolutionFailed l o instance (info ~ ResolveDatagramBasedMethod t DatagramBased, O.OverloadedMethod info DatagramBased p) => OL.IsLabel t (DatagramBased -> p) where #if MIN_VERSION_base(4,10,0) fromLabel = O.overloadedMethod @info #else fromLabel _ = O.overloadedMethod @info #endif #if MIN_VERSION_base(4,13,0) instance (info ~ ResolveDatagramBasedMethod t DatagramBased, O.OverloadedMethod info DatagramBased p, R.HasField t DatagramBased p) => R.HasField t DatagramBased p where getField = O.overloadedMethod @info #endif instance (info ~ ResolveDatagramBasedMethod t DatagramBased, O.OverloadedMethodInfo info DatagramBased) => OL.IsLabel t (O.MethodProxy info DatagramBased) where #if MIN_VERSION_base(4,10,0) fromLabel = O.MethodProxy #else fromLabel _ = O.MethodProxy #endif #endif -- method DatagramBased::condition_check -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "datagram_based" -- , argType = -- TInterface Name { namespace = "Gio" , name = "DatagramBased" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GDatagramBased" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "condition" -- , argType = -- TInterface Name { namespace = "GLib" , name = "IOCondition" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GIOCondition mask to check" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "GLib" , name = "IOCondition" }) -- throws : False -- Skip return : False foreign import ccall "g_datagram_based_condition_check" g_datagram_based_condition_check :: Ptr DatagramBased -> -- datagram_based : TInterface (Name {namespace = "Gio", name = "DatagramBased"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) IO CUInt -- | Checks on the readiness of /@datagramBased@/ to perform operations. The -- operations specified in /@condition@/ are checked for and masked against the -- currently-satisfied conditions on /@datagramBased@/. The result is returned. -- -- 'GI.GObject.Flags.IOConditionIn' will be set in the return value if data is available to read with -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedReceiveMessages', or if the connection is closed remotely -- (EOS); and if the datagram_based has not been closed locally using some -- implementation-specific method (such as 'GI.Gio.Objects.Socket.socketClose' or -- 'GI.Gio.Objects.Socket.socketShutdown' with /@shutdownRead@/ set, if it’s a t'GI.Gio.Objects.Socket.Socket'). -- -- If the connection is shut down or closed (by calling 'GI.Gio.Objects.Socket.socketClose' or -- 'GI.Gio.Objects.Socket.socketShutdown' with /@shutdownRead@/ set, if it’s a t'GI.Gio.Objects.Socket.Socket', for -- example), all calls to this function will return 'GI.Gio.Enums.IOErrorEnumClosed'. -- -- 'GI.GObject.Flags.IOConditionOut' will be set if it is expected that at least one byte can be sent -- using 'GI.Gio.Interfaces.DatagramBased.datagramBasedSendMessages' without blocking. It will not be set -- if the datagram_based has been closed locally. -- -- 'GI.GObject.Flags.IOConditionHup' will be set if the connection has been closed locally. -- -- 'GI.GObject.Flags.IOConditionErr' will be set if there was an asynchronous error in transmitting data -- previously enqueued using 'GI.Gio.Interfaces.DatagramBased.datagramBasedSendMessages'. -- -- Note that on Windows, it is possible for an operation to return -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' even immediately after -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedConditionCheck' has claimed that the t'GI.Gio.Interfaces.DatagramBased.DatagramBased' is -- ready for writing. Rather than calling 'GI.Gio.Interfaces.DatagramBased.datagramBasedConditionCheck' and -- then writing to the t'GI.Gio.Interfaces.DatagramBased.DatagramBased' if it succeeds, it is generally better to -- simply try writing right away, and try again later if the initial attempt -- returns 'GI.Gio.Enums.IOErrorEnumWouldBlock'. -- -- It is meaningless to specify 'GI.GObject.Flags.IOConditionErr' or 'GI.GObject.Flags.IOConditionHup' in /@condition@/; these -- conditions will always be set in the output if they are true. Apart from -- these flags, the output is guaranteed to be masked by /@condition@/. -- -- This call never blocks. -- -- /Since: 2.48/ datagramBasedConditionCheck :: (B.CallStack.HasCallStack, MonadIO m, IsDatagramBased a) => a -- ^ /@datagramBased@/: a t'GI.Gio.Interfaces.DatagramBased.DatagramBased' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GObject.Flags.IOCondition' mask to check -> m [GLib.Flags.IOCondition] -- ^ __Returns:__ the t'GI.GObject.Flags.IOCondition' mask of the current state datagramBasedConditionCheck :: forall (m :: * -> *) a. (HasCallStack, MonadIO m, IsDatagramBased a) => a -> [IOCondition] -> m [IOCondition] datagramBasedConditionCheck a datagramBased [IOCondition] condition = IO [IOCondition] -> m [IOCondition] forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a liftIO (IO [IOCondition] -> m [IOCondition]) -> IO [IOCondition] -> m [IOCondition] forall a b. (a -> b) -> a -> b $ do datagramBased' <- a -> IO (Ptr DatagramBased) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr a datagramBased let condition' = [IOCondition] -> CUInt forall b a. (Num b, IsGFlag a) => [a] -> b gflagsToWord [IOCondition] condition result <- g_datagram_based_condition_check datagramBased' condition' let result' = CUInt -> [IOCondition] forall a b. (Storable a, Integral a, Bits a, IsGFlag b) => a -> [b] wordToGFlags CUInt result touchManagedPtr datagramBased return result' #if defined(ENABLE_OVERLOADING) data DatagramBasedConditionCheckMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> m [GLib.Flags.IOCondition]), MonadIO m, IsDatagramBased a) => O.OverloadedMethod DatagramBasedConditionCheckMethodInfo a signature where overloadedMethod = datagramBasedConditionCheck instance O.OverloadedMethodInfo DatagramBasedConditionCheckMethodInfo a where overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo { O.resolvedSymbolName = "GI.Gio.Interfaces.DatagramBased.datagramBasedConditionCheck", O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.35/docs/GI-Gio-Interfaces-DatagramBased.html#v:datagramBasedConditionCheck" }) #endif -- method DatagramBased::condition_wait -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "datagram_based" -- , argType = -- TInterface Name { namespace = "Gio" , name = "DatagramBased" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GDatagramBased" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "condition" -- , argType = -- TInterface Name { namespace = "GLib" , name = "IOCondition" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GIOCondition mask to wait for" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout" -- , argType = TBasicType TInt64 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "the maximum time (in microseconds) to wait, 0 to not block, or -1\n to block indefinitely" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GCancellable" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : True -- Skip return : False foreign import ccall "g_datagram_based_condition_wait" g_datagram_based_condition_wait :: Ptr DatagramBased -> -- datagram_based : TInterface (Name {namespace = "Gio", name = "DatagramBased"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) Int64 -> -- timeout : TBasicType TInt64 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO CInt -- | Waits for up to /@timeout@/ microseconds for condition to become true on -- /@datagramBased@/. If the condition is met, 'P.True' is returned. -- -- If /@cancellable@/ is cancelled before the condition is met, or if /@timeout@/ is -- reached before the condition is met, then 'P.False' is returned and /@error@/ is -- set appropriately ('GI.Gio.Enums.IOErrorEnumCancelled' or 'GI.Gio.Enums.IOErrorEnumTimedOut'). -- -- /Since: 2.48/ datagramBasedConditionWait :: (B.CallStack.HasCallStack, MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => a -- ^ /@datagramBased@/: a t'GI.Gio.Interfaces.DatagramBased.DatagramBased' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GObject.Flags.IOCondition' mask to wait for -> Int64 -- ^ /@timeout@/: the maximum time (in microseconds) to wait, 0 to not block, or -1 -- to block indefinitely -> Maybe (b) -- ^ /@cancellable@/: a t'GI.Gio.Objects.Cancellable.Cancellable' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ datagramBasedConditionWait :: forall (m :: * -> *) a b. (HasCallStack, MonadIO m, IsDatagramBased a, IsCancellable b) => a -> [IOCondition] -> Int64 -> Maybe b -> m () datagramBasedConditionWait a datagramBased [IOCondition] condition Int64 timeout Maybe b cancellable = IO () -> m () forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a liftIO (IO () -> m ()) -> IO () -> m () forall a b. (a -> b) -> a -> b $ do datagramBased' <- a -> IO (Ptr DatagramBased) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr a datagramBased let condition' = [IOCondition] -> CUInt forall b a. (Num b, IsGFlag a) => [a] -> b gflagsToWord [IOCondition] condition maybeCancellable <- case cancellable of Maybe b Nothing -> Ptr Cancellable -> IO (Ptr Cancellable) forall a. a -> IO a forall (m :: * -> *) a. Monad m => a -> m a return Ptr Cancellable forall a. Ptr a FP.nullPtr Just b jCancellable -> do jCancellable' <- b -> IO (Ptr Cancellable) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr b jCancellable return jCancellable' onException (do _ <- propagateGError $ g_datagram_based_condition_wait datagramBased' condition' timeout maybeCancellable touchManagedPtr datagramBased whenJust cancellable touchManagedPtr return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data DatagramBasedConditionWaitMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> Int64 -> Maybe (b) -> m ()), MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => O.OverloadedMethod DatagramBasedConditionWaitMethodInfo a signature where overloadedMethod = datagramBasedConditionWait instance O.OverloadedMethodInfo DatagramBasedConditionWaitMethodInfo a where overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo { O.resolvedSymbolName = "GI.Gio.Interfaces.DatagramBased.datagramBasedConditionWait", O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.35/docs/GI-Gio-Interfaces-DatagramBased.html#v:datagramBasedConditionWait" }) #endif -- method DatagramBased::create_source -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "datagram_based" -- , argType = -- TInterface Name { namespace = "Gio" , name = "DatagramBased" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GDatagramBased" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "condition" -- , argType = -- TInterface Name { namespace = "GLib" , name = "IOCondition" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GIOCondition mask to monitor" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GCancellable" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "GLib" , name = "Source" }) -- throws : False -- Skip return : False foreign import ccall "g_datagram_based_create_source" g_datagram_based_create_source :: Ptr DatagramBased -> -- datagram_based : TInterface (Name {namespace = "Gio", name = "DatagramBased"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) IO (Ptr GLib.Source.Source) -- | Creates a t'GI.GLib.Structs.Source.Source' that can be attached to a t'GI.GLib.Structs.MainContext.MainContext' to monitor for -- the availability of the specified /@condition@/ on the t'GI.Gio.Interfaces.DatagramBased.DatagramBased'. The -- t'GI.GLib.Structs.Source.Source' keeps a reference to the /@datagramBased@/. -- -- The callback on the source is of the t'GI.Gio.Callbacks.DatagramBasedSourceFunc' type. -- -- It is meaningless to specify 'GI.GObject.Flags.IOConditionErr' or 'GI.GObject.Flags.IOConditionHup' in /@condition@/; these -- conditions will always be reported in the callback if they are true. -- -- If non-'P.Nothing', /@cancellable@/ can be used to cancel the source, which will -- cause the source to trigger, reporting the current condition (which is -- likely 0 unless cancellation happened at the same time as a condition -- change). You can check for this in the callback using -- 'GI.Gio.Objects.Cancellable.cancellableIsCancelled'. -- -- /Since: 2.48/ datagramBasedCreateSource :: (B.CallStack.HasCallStack, MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => a -- ^ /@datagramBased@/: a t'GI.Gio.Interfaces.DatagramBased.DatagramBased' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GObject.Flags.IOCondition' mask to monitor -> Maybe (b) -- ^ /@cancellable@/: a t'GI.Gio.Objects.Cancellable.Cancellable' -> m GLib.Source.Source -- ^ __Returns:__ a newly allocated t'GI.GLib.Structs.Source.Source' datagramBasedCreateSource :: forall (m :: * -> *) a b. (HasCallStack, MonadIO m, IsDatagramBased a, IsCancellable b) => a -> [IOCondition] -> Maybe b -> m Source datagramBasedCreateSource a datagramBased [IOCondition] condition Maybe b cancellable = IO Source -> m Source forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a liftIO (IO Source -> m Source) -> IO Source -> m Source forall a b. (a -> b) -> a -> b $ do datagramBased' <- a -> IO (Ptr DatagramBased) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr a datagramBased let condition' = [IOCondition] -> CUInt forall b a. (Num b, IsGFlag a) => [a] -> b gflagsToWord [IOCondition] condition maybeCancellable <- case cancellable of Maybe b Nothing -> Ptr Cancellable -> IO (Ptr Cancellable) forall a. a -> IO a forall (m :: * -> *) a. Monad m => a -> m a return Ptr Cancellable forall a. Ptr a FP.nullPtr Just b jCancellable -> do jCancellable' <- b -> IO (Ptr Cancellable) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr b jCancellable return jCancellable' result <- g_datagram_based_create_source datagramBased' condition' maybeCancellable checkUnexpectedReturnNULL "datagramBasedCreateSource" result result' <- (wrapBoxed GLib.Source.Source) result touchManagedPtr datagramBased whenJust cancellable touchManagedPtr return result' #if defined(ENABLE_OVERLOADING) data DatagramBasedCreateSourceMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> Maybe (b) -> m GLib.Source.Source), MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => O.OverloadedMethod DatagramBasedCreateSourceMethodInfo a signature where overloadedMethod = datagramBasedCreateSource instance O.OverloadedMethodInfo DatagramBasedCreateSourceMethodInfo a where overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo { O.resolvedSymbolName = "GI.Gio.Interfaces.DatagramBased.datagramBasedCreateSource", O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.35/docs/GI-Gio-Interfaces-DatagramBased.html#v:datagramBasedCreateSource" }) #endif -- method DatagramBased::receive_messages -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "datagram_based" -- , argType = -- TInterface Name { namespace = "Gio" , name = "DatagramBased" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GDatagramBased" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "messages" -- , argType = -- TCArray -- False -- (-1) -- 2 -- (TInterface Name { namespace = "Gio" , name = "InputMessage" }) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an array of #GInputMessage structs" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_messages" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @messages" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "an int containing #GSocketMsgFlags flags for the overall operation" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout" -- , argType = TBasicType TInt64 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "the maximum time (in microseconds) to wait, 0 to not block, or -1\n to block indefinitely" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "num_messages" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @messages" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt) -- throws : True -- Skip return : False foreign import ccall "g_datagram_based_receive_messages" g_datagram_based_receive_messages :: Ptr DatagramBased -> -- datagram_based : TInterface (Name {namespace = "Gio", name = "DatagramBased"}) Ptr Gio.InputMessage.InputMessage -> -- messages : TCArray False (-1) 2 (TInterface (Name {namespace = "Gio", name = "InputMessage"})) Word32 -> -- num_messages : TBasicType TUInt Int32 -> -- flags : TBasicType TInt Int64 -> -- timeout : TBasicType TInt64 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Receive one or more data messages from /@datagramBased@/ in one go. -- -- /@messages@/ must point to an array of t'GI.Gio.Structs.InputMessage.InputMessage' structs and -- /@numMessages@/ must be the length of this array. Each t'GI.Gio.Structs.InputMessage.InputMessage' -- contains a pointer to an array of t'GI.Gio.Structs.InputVector.InputVector' structs describing the -- buffers that the data received in each message will be written to. -- -- /@flags@/ modify how all messages are received. The commonly available -- arguments for this are available in the t'GI.Gio.Flags.SocketMsgFlags' enum, but the -- values there are the same as the system values, and the flags -- are passed in as-is, so you can pass in system-specific flags too. These -- flags affect the overall receive operation. Flags affecting individual -- messages are returned in t'GI.Gio.Structs.InputMessage.InputMessage'.@/flags/@. -- -- The other members of t'GI.Gio.Structs.InputMessage.InputMessage' are treated as described in its -- documentation. -- -- If /@timeout@/ is negative the call will block until /@numMessages@/ have been -- received, the connection is closed remotely (EOS), /@cancellable@/ is cancelled, -- or an error occurs. -- -- If /@timeout@/ is 0 the call will return up to /@numMessages@/ without blocking, -- or 'GI.Gio.Enums.IOErrorEnumWouldBlock' if no messages are queued in the operating system -- to be received. -- -- If /@timeout@/ is positive the call will block on the same conditions as if -- /@timeout@/ were negative. If the timeout is reached -- before any messages are received, 'GI.Gio.Enums.IOErrorEnumTimedOut' is returned, -- otherwise it will return the number of messages received before timing out. -- (Note: This is effectively the behaviour of @MSG_WAITFORONE@ with -- @/recvmmsg()/@.) -- -- To be notified when messages are available, wait for the 'GI.GObject.Flags.IOConditionIn' condition. -- Note though that you may still receive 'GI.Gio.Enums.IOErrorEnumWouldBlock' from -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedReceiveMessages' even if you were previously notified of a -- 'GI.GObject.Flags.IOConditionIn' condition. -- -- If the remote peer closes the connection, any messages queued in the -- underlying receive buffer will be returned, and subsequent calls to -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedReceiveMessages' will return 0 (with no error set). -- -- If the connection is shut down or closed (by calling 'GI.Gio.Objects.Socket.socketClose' or -- 'GI.Gio.Objects.Socket.socketShutdown' with /@shutdownRead@/ set, if it’s a t'GI.Gio.Objects.Socket.Socket', for -- example), all calls to this function will return 'GI.Gio.Enums.IOErrorEnumClosed'. -- -- On error -1 is returned and /@error@/ is set accordingly. An error will only -- be returned if zero messages could be received; otherwise the number of -- messages successfully received before the error will be returned. If -- /@cancellable@/ is cancelled, 'GI.Gio.Enums.IOErrorEnumCancelled' is returned as with any -- other error. -- -- /Since: 2.48/ datagramBasedReceiveMessages :: (B.CallStack.HasCallStack, MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => a -- ^ /@datagramBased@/: a t'GI.Gio.Interfaces.DatagramBased.DatagramBased' -> [Gio.InputMessage.InputMessage] -- ^ /@messages@/: an array of t'GI.Gio.Structs.InputMessage.InputMessage' structs -> Int32 -- ^ /@flags@/: an int containing t'GI.Gio.Flags.SocketMsgFlags' flags for the overall operation -> Int64 -- ^ /@timeout@/: the maximum time (in microseconds) to wait, 0 to not block, or -1 -- to block indefinitely -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ -> m Int32 -- ^ __Returns:__ number of messages received, or -1 on error. Note that the number -- of messages received may be smaller than /@numMessages@/ if /@timeout@/ is -- zero or positive, if the peer closed the connection, or if /@numMessages@/ -- was larger than @UIO_MAXIOV@ (1024), in which case the caller may re-try -- to receive the remaining messages. /(Can throw 'Data.GI.Base.GError.GError')/ datagramBasedReceiveMessages :: forall (m :: * -> *) a b. (HasCallStack, MonadIO m, IsDatagramBased a, IsCancellable b) => a -> [InputMessage] -> Int32 -> Int64 -> Maybe b -> m Int32 datagramBasedReceiveMessages a datagramBased [InputMessage] messages Int32 flags Int64 timeout Maybe b cancellable = IO Int32 -> m Int32 forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a liftIO (IO Int32 -> m Int32) -> IO Int32 -> m Int32 forall a b. (a -> b) -> a -> b $ do let numMessages :: Word32 numMessages = Int -> Word32 forall a b. (Integral a, Num b) => a -> b fromIntegral (Int -> Word32) -> Int -> Word32 forall a b. (a -> b) -> a -> b $ [InputMessage] -> Int forall a. [a] -> Int forall (t :: * -> *) a. Foldable t => t a -> Int P.length [InputMessage] messages datagramBased' <- a -> IO (Ptr DatagramBased) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr a datagramBased messages' <- mapM unsafeManagedPtrGetPtr messages messages'' <- packBlockArray 56 messages' maybeCancellable <- case cancellable of Maybe b Nothing -> Ptr Cancellable -> IO (Ptr Cancellable) forall a. a -> IO a forall (m :: * -> *) a. Monad m => a -> m a return Ptr Cancellable forall a. Ptr a FP.nullPtr Just b jCancellable -> do jCancellable' <- b -> IO (Ptr Cancellable) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr b jCancellable return jCancellable' onException (do result <- propagateGError $ g_datagram_based_receive_messages datagramBased' messages'' numMessages flags timeout maybeCancellable touchManagedPtr datagramBased mapM_ touchManagedPtr messages whenJust cancellable touchManagedPtr freeMem messages'' return result ) (do freeMem messages'' ) #if defined(ENABLE_OVERLOADING) data DatagramBasedReceiveMessagesMethodInfo instance (signature ~ ([Gio.InputMessage.InputMessage] -> Int32 -> Int64 -> Maybe (b) -> m Int32), MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => O.OverloadedMethod DatagramBasedReceiveMessagesMethodInfo a signature where overloadedMethod = datagramBasedReceiveMessages instance O.OverloadedMethodInfo DatagramBasedReceiveMessagesMethodInfo a where overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo { O.resolvedSymbolName = "GI.Gio.Interfaces.DatagramBased.datagramBasedReceiveMessages", O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.35/docs/GI-Gio-Interfaces-DatagramBased.html#v:datagramBasedReceiveMessages" }) #endif -- method DatagramBased::send_messages -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "datagram_based" -- , argType = -- TInterface Name { namespace = "Gio" , name = "DatagramBased" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GDatagramBased" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "messages" -- , argType = -- TCArray -- False -- (-1) -- 2 -- (TInterface Name { namespace = "Gio" , name = "OutputMessage" }) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an array of #GOutputMessage structs" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_messages" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @messages" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an int containing #GSocketMsgFlags flags" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout" -- , argType = TBasicType TInt64 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "the maximum time (in microseconds) to wait, 0 to not block, or -1\n to block indefinitely" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "num_messages" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @messages" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , argCallbackUserData = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt) -- throws : True -- Skip return : False foreign import ccall "g_datagram_based_send_messages" g_datagram_based_send_messages :: Ptr DatagramBased -> -- datagram_based : TInterface (Name {namespace = "Gio", name = "DatagramBased"}) Ptr Gio.OutputMessage.OutputMessage -> -- messages : TCArray False (-1) 2 (TInterface (Name {namespace = "Gio", name = "OutputMessage"})) Word32 -> -- num_messages : TBasicType TUInt Int32 -> -- flags : TBasicType TInt Int64 -> -- timeout : TBasicType TInt64 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Send one or more data messages from /@datagramBased@/ in one go. -- -- /@messages@/ must point to an array of t'GI.Gio.Structs.OutputMessage.OutputMessage' structs and -- /@numMessages@/ must be the length of this array. Each t'GI.Gio.Structs.OutputMessage.OutputMessage' -- contains an address to send the data to, and a pointer to an array of -- t'GI.Gio.Structs.OutputVector.OutputVector' structs to describe the buffers that the data to be sent -- for each message will be gathered from. -- -- /@flags@/ modify how the message is sent. The commonly available arguments -- for this are available in the t'GI.Gio.Flags.SocketMsgFlags' enum, but the -- values there are the same as the system values, and the flags -- are passed in as-is, so you can pass in system-specific flags too. -- -- The other members of t'GI.Gio.Structs.OutputMessage.OutputMessage' are treated as described in its -- documentation. -- -- If /@timeout@/ is negative the call will block until /@numMessages@/ have been -- sent, /@cancellable@/ is cancelled, or an error occurs. -- -- If /@timeout@/ is 0 the call will send up to /@numMessages@/ without blocking, -- or will return 'GI.Gio.Enums.IOErrorEnumWouldBlock' if there is no space to send messages. -- -- If /@timeout@/ is positive the call will block on the same conditions as if -- /@timeout@/ were negative. If the timeout is reached before any messages are -- sent, 'GI.Gio.Enums.IOErrorEnumTimedOut' is returned, otherwise it will return the number -- of messages sent before timing out. -- -- To be notified when messages can be sent, wait for the 'GI.GObject.Flags.IOConditionOut' condition. -- Note though that you may still receive 'GI.Gio.Enums.IOErrorEnumWouldBlock' from -- 'GI.Gio.Interfaces.DatagramBased.datagramBasedSendMessages' even if you were previously notified of a -- 'GI.GObject.Flags.IOConditionOut' condition. (On Windows in particular, this is very common due to -- the way the underlying APIs work.) -- -- If the connection is shut down or closed (by calling 'GI.Gio.Objects.Socket.socketClose' or -- 'GI.Gio.Objects.Socket.socketShutdown' with /@shutdownWrite@/ set, if it’s a t'GI.Gio.Objects.Socket.Socket', for -- example), all calls to this function will return 'GI.Gio.Enums.IOErrorEnumClosed'. -- -- On error -1 is returned and /@error@/ is set accordingly. An error will only -- be returned if zero messages could be sent; otherwise the number of messages -- successfully sent before the error will be returned. If /@cancellable@/ is -- cancelled, 'GI.Gio.Enums.IOErrorEnumCancelled' is returned as with any other error. -- -- /Since: 2.48/ datagramBasedSendMessages :: (B.CallStack.HasCallStack, MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => a -- ^ /@datagramBased@/: a t'GI.Gio.Interfaces.DatagramBased.DatagramBased' -> [Gio.OutputMessage.OutputMessage] -- ^ /@messages@/: an array of t'GI.Gio.Structs.OutputMessage.OutputMessage' structs -> Int32 -- ^ /@flags@/: an int containing t'GI.Gio.Flags.SocketMsgFlags' flags -> Int64 -- ^ /@timeout@/: the maximum time (in microseconds) to wait, 0 to not block, or -1 -- to block indefinitely -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ -> m Int32 -- ^ __Returns:__ number of messages sent, or -1 on error. Note that the number of -- messages sent may be smaller than /@numMessages@/ if /@timeout@/ is zero -- or positive, or if /@numMessages@/ was larger than @UIO_MAXIOV@ (1024), in -- which case the caller may re-try to send the remaining messages. /(Can throw 'Data.GI.Base.GError.GError')/ datagramBasedSendMessages :: forall (m :: * -> *) a b. (HasCallStack, MonadIO m, IsDatagramBased a, IsCancellable b) => a -> [OutputMessage] -> Int32 -> Int64 -> Maybe b -> m Int32 datagramBasedSendMessages a datagramBased [OutputMessage] messages Int32 flags Int64 timeout Maybe b cancellable = IO Int32 -> m Int32 forall a. IO a -> m a forall (m :: * -> *) a. MonadIO m => IO a -> m a liftIO (IO Int32 -> m Int32) -> IO Int32 -> m Int32 forall a b. (a -> b) -> a -> b $ do let numMessages :: Word32 numMessages = Int -> Word32 forall a b. (Integral a, Num b) => a -> b fromIntegral (Int -> Word32) -> Int -> Word32 forall a b. (a -> b) -> a -> b $ [OutputMessage] -> Int forall a. [a] -> Int forall (t :: * -> *) a. Foldable t => t a -> Int P.length [OutputMessage] messages datagramBased' <- a -> IO (Ptr DatagramBased) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr a datagramBased messages' <- mapM unsafeManagedPtrGetPtr messages messages'' <- packBlockArray 40 messages' maybeCancellable <- case cancellable of Maybe b Nothing -> Ptr Cancellable -> IO (Ptr Cancellable) forall a. a -> IO a forall (m :: * -> *) a. Monad m => a -> m a return Ptr Cancellable forall a. Ptr a FP.nullPtr Just b jCancellable -> do jCancellable' <- b -> IO (Ptr Cancellable) forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b) unsafeManagedPtrCastPtr b jCancellable return jCancellable' onException (do result <- propagateGError $ g_datagram_based_send_messages datagramBased' messages'' numMessages flags timeout maybeCancellable touchManagedPtr datagramBased mapM_ touchManagedPtr messages whenJust cancellable touchManagedPtr freeMem messages'' return result ) (do freeMem messages'' ) #if defined(ENABLE_OVERLOADING) data DatagramBasedSendMessagesMethodInfo instance (signature ~ ([Gio.OutputMessage.OutputMessage] -> Int32 -> Int64 -> Maybe (b) -> m Int32), MonadIO m, IsDatagramBased a, Gio.Cancellable.IsCancellable b) => O.OverloadedMethod DatagramBasedSendMessagesMethodInfo a signature where overloadedMethod = datagramBasedSendMessages instance O.OverloadedMethodInfo DatagramBasedSendMessagesMethodInfo a where overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo { O.resolvedSymbolName = "GI.Gio.Interfaces.DatagramBased.datagramBasedSendMessages", O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-gio-2.0.35/docs/GI-Gio-Interfaces-DatagramBased.html#v:datagramBasedSendMessages" }) #endif #if defined(ENABLE_OVERLOADING) type instance O.SignalList DatagramBased = DatagramBasedSignalList type DatagramBasedSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, DK.Type)]) #endif