{-# LANGUAGE TypeApplications #-} -- | Copyright : Will Thompson, Iñaki García Etxebarria and Jonas Platte -- License : LGPL-2.1 -- Maintainer : Iñaki García Etxebarria -- -- A t'GI.Gio.Objects.Socket.Socket' is a low-level networking primitive. It is a more or less -- direct mapping of the BSD socket API in a portable GObject based API. -- It supports both the UNIX socket implementations and winsock2 on Windows. -- -- t'GI.Gio.Objects.Socket.Socket' is the platform independent base upon which the higher level -- network primitives are based. Applications are not typically meant to -- use it directly, but rather through classes like t'GI.Gio.Objects.SocketClient.SocketClient', -- t'GI.Gio.Objects.SocketService.SocketService' and t'GI.Gio.Objects.SocketConnection.SocketConnection'. However there may be cases where -- direct use of t'GI.Gio.Objects.Socket.Socket' is useful. -- -- t'GI.Gio.Objects.Socket.Socket' implements the t'GI.Gio.Interfaces.Initable.Initable' interface, so if it is manually constructed -- by e.g. @/g_object_new()/@ you must call 'GI.Gio.Interfaces.Initable.initableInit' and check the -- results before using the object. This is done automatically in -- 'GI.Gio.Objects.Socket.socketNew' and 'GI.Gio.Objects.Socket.socketNewFromFd', so these functions can return -- 'P.Nothing'. -- -- Sockets operate in two general modes, blocking or non-blocking. When -- in blocking mode all operations (which don’t take an explicit blocking -- parameter) block until the requested operation -- is finished or there is an error. In non-blocking mode all calls that -- would block return immediately with a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error. -- To know when a call would successfully run you can call 'GI.Gio.Objects.Socket.socketConditionCheck', -- or 'GI.Gio.Objects.Socket.socketConditionWait'. You can also use @/g_socket_create_source()/@ and -- attach it to a t'GI.GLib.Structs.MainContext.MainContext' to get callbacks when I\/O is possible. -- Note that all sockets are always set to non blocking mode in the system, and -- blocking mode is emulated in GSocket. -- -- When working in non-blocking mode applications should always be able to -- handle getting a 'GI.Gio.Enums.IOErrorEnumWouldBlock' 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 'GI.Gio.Enums.IOErrorEnumWouldBlock'. -- -- @/GSockets/@ can be either connection oriented or datagram based. -- For connection oriented types you must first establish a connection by -- either connecting to an address or accepting a connection from another -- address. For connectionless socket types the target\/source address is -- specified or received in each I\/O operation. -- -- All socket file descriptors are set to be close-on-exec. -- -- Note that creating a t'GI.Gio.Objects.Socket.Socket' causes the signal @/SIGPIPE/@ to be -- ignored for the remainder of the program. If you are writing a -- command-line utility that uses t'GI.Gio.Objects.Socket.Socket', you may need to take into -- account the fact that your program will not automatically be killed -- if it tries to write to @/stdout/@ after it has been closed. -- -- Like most other APIs in GLib, t'GI.Gio.Objects.Socket.Socket' is not inherently thread safe. To use -- a t'GI.Gio.Objects.Socket.Socket' concurrently from multiple threads, you must implement your own -- locking. -- -- /Since: 2.22/ #if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__)) #define ENABLE_OVERLOADING #endif module GI.Gio.Objects.Socket ( -- * Exported types Socket(..) , IsSocket , toSocket , noSocket , -- * Methods -- ** Overloaded methods #method:Overloaded methods# #if defined(ENABLE_OVERLOADING) ResolveSocketMethod , #endif -- ** accept #method:accept# #if defined(ENABLE_OVERLOADING) SocketAcceptMethodInfo , #endif socketAccept , -- ** bind #method:bind# #if defined(ENABLE_OVERLOADING) SocketBindMethodInfo , #endif socketBind , -- ** checkConnectResult #method:checkConnectResult# #if defined(ENABLE_OVERLOADING) SocketCheckConnectResultMethodInfo , #endif socketCheckConnectResult , -- ** close #method:close# #if defined(ENABLE_OVERLOADING) SocketCloseMethodInfo , #endif socketClose , -- ** conditionCheck #method:conditionCheck# #if defined(ENABLE_OVERLOADING) SocketConditionCheckMethodInfo , #endif socketConditionCheck , -- ** conditionTimedWait #method:conditionTimedWait# #if defined(ENABLE_OVERLOADING) SocketConditionTimedWaitMethodInfo , #endif socketConditionTimedWait , -- ** conditionWait #method:conditionWait# #if defined(ENABLE_OVERLOADING) SocketConditionWaitMethodInfo , #endif socketConditionWait , -- ** connect #method:connect# #if defined(ENABLE_OVERLOADING) SocketConnectMethodInfo , #endif socketConnect , -- ** connectionFactoryCreateConnection #method:connectionFactoryCreateConnection# #if defined(ENABLE_OVERLOADING) SocketConnectionFactoryCreateConnectionMethodInfo, #endif socketConnectionFactoryCreateConnection , -- ** getAvailableBytes #method:getAvailableBytes# #if defined(ENABLE_OVERLOADING) SocketGetAvailableBytesMethodInfo , #endif socketGetAvailableBytes , -- ** getBlocking #method:getBlocking# #if defined(ENABLE_OVERLOADING) SocketGetBlockingMethodInfo , #endif socketGetBlocking , -- ** getBroadcast #method:getBroadcast# #if defined(ENABLE_OVERLOADING) SocketGetBroadcastMethodInfo , #endif socketGetBroadcast , -- ** getCredentials #method:getCredentials# #if defined(ENABLE_OVERLOADING) SocketGetCredentialsMethodInfo , #endif socketGetCredentials , -- ** getFamily #method:getFamily# #if defined(ENABLE_OVERLOADING) SocketGetFamilyMethodInfo , #endif socketGetFamily , -- ** getFd #method:getFd# #if defined(ENABLE_OVERLOADING) SocketGetFdMethodInfo , #endif socketGetFd , -- ** getKeepalive #method:getKeepalive# #if defined(ENABLE_OVERLOADING) SocketGetKeepaliveMethodInfo , #endif socketGetKeepalive , -- ** getListenBacklog #method:getListenBacklog# #if defined(ENABLE_OVERLOADING) SocketGetListenBacklogMethodInfo , #endif socketGetListenBacklog , -- ** getLocalAddress #method:getLocalAddress# #if defined(ENABLE_OVERLOADING) SocketGetLocalAddressMethodInfo , #endif socketGetLocalAddress , -- ** getMulticastLoopback #method:getMulticastLoopback# #if defined(ENABLE_OVERLOADING) SocketGetMulticastLoopbackMethodInfo , #endif socketGetMulticastLoopback , -- ** getMulticastTtl #method:getMulticastTtl# #if defined(ENABLE_OVERLOADING) SocketGetMulticastTtlMethodInfo , #endif socketGetMulticastTtl , -- ** getOption #method:getOption# #if defined(ENABLE_OVERLOADING) SocketGetOptionMethodInfo , #endif socketGetOption , -- ** getProtocol #method:getProtocol# #if defined(ENABLE_OVERLOADING) SocketGetProtocolMethodInfo , #endif socketGetProtocol , -- ** getRemoteAddress #method:getRemoteAddress# #if defined(ENABLE_OVERLOADING) SocketGetRemoteAddressMethodInfo , #endif socketGetRemoteAddress , -- ** getSocketType #method:getSocketType# #if defined(ENABLE_OVERLOADING) SocketGetSocketTypeMethodInfo , #endif socketGetSocketType , -- ** getTimeout #method:getTimeout# #if defined(ENABLE_OVERLOADING) SocketGetTimeoutMethodInfo , #endif socketGetTimeout , -- ** getTtl #method:getTtl# #if defined(ENABLE_OVERLOADING) SocketGetTtlMethodInfo , #endif socketGetTtl , -- ** isClosed #method:isClosed# #if defined(ENABLE_OVERLOADING) SocketIsClosedMethodInfo , #endif socketIsClosed , -- ** isConnected #method:isConnected# #if defined(ENABLE_OVERLOADING) SocketIsConnectedMethodInfo , #endif socketIsConnected , -- ** joinMulticastGroup #method:joinMulticastGroup# #if defined(ENABLE_OVERLOADING) SocketJoinMulticastGroupMethodInfo , #endif socketJoinMulticastGroup , -- ** joinMulticastGroupSsm #method:joinMulticastGroupSsm# #if defined(ENABLE_OVERLOADING) SocketJoinMulticastGroupSsmMethodInfo , #endif socketJoinMulticastGroupSsm , -- ** leaveMulticastGroup #method:leaveMulticastGroup# #if defined(ENABLE_OVERLOADING) SocketLeaveMulticastGroupMethodInfo , #endif socketLeaveMulticastGroup , -- ** leaveMulticastGroupSsm #method:leaveMulticastGroupSsm# #if defined(ENABLE_OVERLOADING) SocketLeaveMulticastGroupSsmMethodInfo , #endif socketLeaveMulticastGroupSsm , -- ** listen #method:listen# #if defined(ENABLE_OVERLOADING) SocketListenMethodInfo , #endif socketListen , -- ** new #method:new# socketNew , -- ** newFromFd #method:newFromFd# socketNewFromFd , -- ** receive #method:receive# #if defined(ENABLE_OVERLOADING) SocketReceiveMethodInfo , #endif socketReceive , -- ** receiveFrom #method:receiveFrom# #if defined(ENABLE_OVERLOADING) SocketReceiveFromMethodInfo , #endif socketReceiveFrom , -- ** receiveMessage #method:receiveMessage# #if defined(ENABLE_OVERLOADING) SocketReceiveMessageMethodInfo , #endif socketReceiveMessage , -- ** receiveMessages #method:receiveMessages# #if defined(ENABLE_OVERLOADING) SocketReceiveMessagesMethodInfo , #endif socketReceiveMessages , -- ** receiveWithBlocking #method:receiveWithBlocking# #if defined(ENABLE_OVERLOADING) SocketReceiveWithBlockingMethodInfo , #endif socketReceiveWithBlocking , -- ** send #method:send# #if defined(ENABLE_OVERLOADING) SocketSendMethodInfo , #endif socketSend , -- ** sendMessage #method:sendMessage# #if defined(ENABLE_OVERLOADING) SocketSendMessageMethodInfo , #endif socketSendMessage , -- ** sendMessageWithTimeout #method:sendMessageWithTimeout# #if defined(ENABLE_OVERLOADING) SocketSendMessageWithTimeoutMethodInfo , #endif socketSendMessageWithTimeout , -- ** sendMessages #method:sendMessages# #if defined(ENABLE_OVERLOADING) SocketSendMessagesMethodInfo , #endif socketSendMessages , -- ** sendTo #method:sendTo# #if defined(ENABLE_OVERLOADING) SocketSendToMethodInfo , #endif socketSendTo , -- ** sendWithBlocking #method:sendWithBlocking# #if defined(ENABLE_OVERLOADING) SocketSendWithBlockingMethodInfo , #endif socketSendWithBlocking , -- ** setBlocking #method:setBlocking# #if defined(ENABLE_OVERLOADING) SocketSetBlockingMethodInfo , #endif socketSetBlocking , -- ** setBroadcast #method:setBroadcast# #if defined(ENABLE_OVERLOADING) SocketSetBroadcastMethodInfo , #endif socketSetBroadcast , -- ** setKeepalive #method:setKeepalive# #if defined(ENABLE_OVERLOADING) SocketSetKeepaliveMethodInfo , #endif socketSetKeepalive , -- ** setListenBacklog #method:setListenBacklog# #if defined(ENABLE_OVERLOADING) SocketSetListenBacklogMethodInfo , #endif socketSetListenBacklog , -- ** setMulticastLoopback #method:setMulticastLoopback# #if defined(ENABLE_OVERLOADING) SocketSetMulticastLoopbackMethodInfo , #endif socketSetMulticastLoopback , -- ** setMulticastTtl #method:setMulticastTtl# #if defined(ENABLE_OVERLOADING) SocketSetMulticastTtlMethodInfo , #endif socketSetMulticastTtl , -- ** setOption #method:setOption# #if defined(ENABLE_OVERLOADING) SocketSetOptionMethodInfo , #endif socketSetOption , -- ** setTimeout #method:setTimeout# #if defined(ENABLE_OVERLOADING) SocketSetTimeoutMethodInfo , #endif socketSetTimeout , -- ** setTtl #method:setTtl# #if defined(ENABLE_OVERLOADING) SocketSetTtlMethodInfo , #endif socketSetTtl , -- ** shutdown #method:shutdown# #if defined(ENABLE_OVERLOADING) SocketShutdownMethodInfo , #endif socketShutdown , -- ** speaksIpv4 #method:speaksIpv4# #if defined(ENABLE_OVERLOADING) SocketSpeaksIpv4MethodInfo , #endif socketSpeaksIpv4 , -- * Properties -- ** blocking #attr:blocking# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketBlockingPropertyInfo , #endif constructSocketBlocking , getSocketBlocking , setSocketBlocking , #if defined(ENABLE_OVERLOADING) socketBlocking , #endif -- ** broadcast #attr:broadcast# -- | Whether the socket should allow sending to broadcast addresses. -- -- /Since: 2.32/ #if defined(ENABLE_OVERLOADING) SocketBroadcastPropertyInfo , #endif constructSocketBroadcast , getSocketBroadcast , setSocketBroadcast , #if defined(ENABLE_OVERLOADING) socketBroadcast , #endif -- ** family #attr:family# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketFamilyPropertyInfo , #endif constructSocketFamily , getSocketFamily , #if defined(ENABLE_OVERLOADING) socketFamily , #endif -- ** fd #attr:fd# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketFdPropertyInfo , #endif constructSocketFd , getSocketFd , #if defined(ENABLE_OVERLOADING) socketFd , #endif -- ** keepalive #attr:keepalive# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketKeepalivePropertyInfo , #endif constructSocketKeepalive , getSocketKeepalive , setSocketKeepalive , #if defined(ENABLE_OVERLOADING) socketKeepalive , #endif -- ** listenBacklog #attr:listenBacklog# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketListenBacklogPropertyInfo , #endif constructSocketListenBacklog , getSocketListenBacklog , setSocketListenBacklog , #if defined(ENABLE_OVERLOADING) socketListenBacklog , #endif -- ** localAddress #attr:localAddress# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketLocalAddressPropertyInfo , #endif getSocketLocalAddress , #if defined(ENABLE_OVERLOADING) socketLocalAddress , #endif -- ** multicastLoopback #attr:multicastLoopback# -- | Whether outgoing multicast packets loop back to the local host. -- -- /Since: 2.32/ #if defined(ENABLE_OVERLOADING) SocketMulticastLoopbackPropertyInfo , #endif constructSocketMulticastLoopback , getSocketMulticastLoopback , setSocketMulticastLoopback , #if defined(ENABLE_OVERLOADING) socketMulticastLoopback , #endif -- ** multicastTtl #attr:multicastTtl# -- | Time-to-live out outgoing multicast packets -- -- /Since: 2.32/ #if defined(ENABLE_OVERLOADING) SocketMulticastTtlPropertyInfo , #endif constructSocketMulticastTtl , getSocketMulticastTtl , setSocketMulticastTtl , #if defined(ENABLE_OVERLOADING) socketMulticastTtl , #endif -- ** protocol #attr:protocol# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketProtocolPropertyInfo , #endif constructSocketProtocol , getSocketProtocol , #if defined(ENABLE_OVERLOADING) socketProtocol , #endif -- ** remoteAddress #attr:remoteAddress# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketRemoteAddressPropertyInfo , #endif getSocketRemoteAddress , #if defined(ENABLE_OVERLOADING) socketRemoteAddress , #endif -- ** timeout #attr:timeout# -- | The timeout in seconds on socket I\/O -- -- /Since: 2.26/ #if defined(ENABLE_OVERLOADING) SocketTimeoutPropertyInfo , #endif constructSocketTimeout , getSocketTimeout , setSocketTimeout , #if defined(ENABLE_OVERLOADING) socketTimeout , #endif -- ** ttl #attr:ttl# -- | Time-to-live for outgoing unicast packets -- -- /Since: 2.32/ #if defined(ENABLE_OVERLOADING) SocketTtlPropertyInfo , #endif constructSocketTtl , getSocketTtl , setSocketTtl , #if defined(ENABLE_OVERLOADING) socketTtl , #endif -- ** type #attr:type# -- | /No description available in the introspection data./ #if defined(ENABLE_OVERLOADING) SocketTypePropertyInfo , #endif constructSocketType , getSocketType , #if defined(ENABLE_OVERLOADING) socketType , #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.GI.Base.Signals as B.Signals 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.GLib.Flags as GLib.Flags import qualified GI.GObject.Objects.Object as GObject.Object import {-# SOURCE #-} qualified GI.Gio.Enums as Gio.Enums import {-# SOURCE #-} qualified GI.Gio.Interfaces.DatagramBased as Gio.DatagramBased import {-# SOURCE #-} qualified GI.Gio.Interfaces.Initable as Gio.Initable import {-# SOURCE #-} qualified GI.Gio.Objects.Cancellable as Gio.Cancellable import {-# SOURCE #-} qualified GI.Gio.Objects.Credentials as Gio.Credentials import {-# SOURCE #-} qualified GI.Gio.Objects.InetAddress as Gio.InetAddress import {-# SOURCE #-} qualified GI.Gio.Objects.SocketAddress as Gio.SocketAddress import {-# SOURCE #-} qualified GI.Gio.Objects.SocketConnection as Gio.SocketConnection import {-# SOURCE #-} qualified GI.Gio.Objects.SocketControlMessage as Gio.SocketControlMessage import {-# SOURCE #-} qualified GI.Gio.Structs.InputMessage as Gio.InputMessage import {-# SOURCE #-} qualified GI.Gio.Structs.InputVector as Gio.InputVector import {-# SOURCE #-} qualified GI.Gio.Structs.OutputMessage as Gio.OutputMessage import {-# SOURCE #-} qualified GI.Gio.Structs.OutputVector as Gio.OutputVector -- | Memory-managed wrapper type. newtype Socket = Socket (ManagedPtr Socket) deriving (Eq) foreign import ccall "g_socket_get_type" c_g_socket_get_type :: IO GType instance GObject Socket where gobjectType = c_g_socket_get_type -- | Convert 'Socket' to and from 'Data.GI.Base.GValue.GValue' with 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'. instance B.GValue.IsGValue Socket where toGValue o = do gtype <- c_g_socket_get_type B.ManagedPtr.withManagedPtr o (B.GValue.buildGValue gtype B.GValue.set_object) fromGValue gv = do ptr <- B.GValue.get_object gv :: IO (Ptr Socket) B.ManagedPtr.newObject Socket ptr -- | Type class for types which can be safely cast to `Socket`, for instance with `toSocket`. class (GObject o, O.IsDescendantOf Socket o) => IsSocket o instance (GObject o, O.IsDescendantOf Socket o) => IsSocket o instance O.HasParentTypes Socket type instance O.ParentTypes Socket = '[GObject.Object.Object, Gio.DatagramBased.DatagramBased, Gio.Initable.Initable] -- | Cast to `Socket`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`. toSocket :: (MonadIO m, IsSocket o) => o -> m Socket toSocket = liftIO . unsafeCastTo Socket -- | A convenience alias for `Nothing` :: `Maybe` `Socket`. noSocket :: Maybe Socket noSocket = Nothing #if defined(ENABLE_OVERLOADING) type family ResolveSocketMethod (t :: Symbol) (o :: *) :: * where ResolveSocketMethod "accept" o = SocketAcceptMethodInfo ResolveSocketMethod "bind" o = SocketBindMethodInfo ResolveSocketMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo ResolveSocketMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo ResolveSocketMethod "checkConnectResult" o = SocketCheckConnectResultMethodInfo ResolveSocketMethod "close" o = SocketCloseMethodInfo ResolveSocketMethod "conditionCheck" o = SocketConditionCheckMethodInfo ResolveSocketMethod "conditionTimedWait" o = SocketConditionTimedWaitMethodInfo ResolveSocketMethod "conditionWait" o = SocketConditionWaitMethodInfo ResolveSocketMethod "connect" o = SocketConnectMethodInfo ResolveSocketMethod "connectionFactoryCreateConnection" o = SocketConnectionFactoryCreateConnectionMethodInfo ResolveSocketMethod "createSource" o = Gio.DatagramBased.DatagramBasedCreateSourceMethodInfo ResolveSocketMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo ResolveSocketMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo ResolveSocketMethod "getv" o = GObject.Object.ObjectGetvMethodInfo ResolveSocketMethod "init" o = Gio.Initable.InitableInitMethodInfo ResolveSocketMethod "isClosed" o = SocketIsClosedMethodInfo ResolveSocketMethod "isConnected" o = SocketIsConnectedMethodInfo ResolveSocketMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo ResolveSocketMethod "joinMulticastGroup" o = SocketJoinMulticastGroupMethodInfo ResolveSocketMethod "joinMulticastGroupSsm" o = SocketJoinMulticastGroupSsmMethodInfo ResolveSocketMethod "leaveMulticastGroup" o = SocketLeaveMulticastGroupMethodInfo ResolveSocketMethod "leaveMulticastGroupSsm" o = SocketLeaveMulticastGroupSsmMethodInfo ResolveSocketMethod "listen" o = SocketListenMethodInfo ResolveSocketMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo ResolveSocketMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo ResolveSocketMethod "receive" o = SocketReceiveMethodInfo ResolveSocketMethod "receiveFrom" o = SocketReceiveFromMethodInfo ResolveSocketMethod "receiveMessage" o = SocketReceiveMessageMethodInfo ResolveSocketMethod "receiveMessages" o = SocketReceiveMessagesMethodInfo ResolveSocketMethod "receiveWithBlocking" o = SocketReceiveWithBlockingMethodInfo ResolveSocketMethod "ref" o = GObject.Object.ObjectRefMethodInfo ResolveSocketMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo ResolveSocketMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo ResolveSocketMethod "send" o = SocketSendMethodInfo ResolveSocketMethod "sendMessage" o = SocketSendMessageMethodInfo ResolveSocketMethod "sendMessageWithTimeout" o = SocketSendMessageWithTimeoutMethodInfo ResolveSocketMethod "sendMessages" o = SocketSendMessagesMethodInfo ResolveSocketMethod "sendTo" o = SocketSendToMethodInfo ResolveSocketMethod "sendWithBlocking" o = SocketSendWithBlockingMethodInfo ResolveSocketMethod "shutdown" o = SocketShutdownMethodInfo ResolveSocketMethod "speaksIpv4" o = SocketSpeaksIpv4MethodInfo ResolveSocketMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo ResolveSocketMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo ResolveSocketMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo ResolveSocketMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo ResolveSocketMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo ResolveSocketMethod "getAvailableBytes" o = SocketGetAvailableBytesMethodInfo ResolveSocketMethod "getBlocking" o = SocketGetBlockingMethodInfo ResolveSocketMethod "getBroadcast" o = SocketGetBroadcastMethodInfo ResolveSocketMethod "getCredentials" o = SocketGetCredentialsMethodInfo ResolveSocketMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo ResolveSocketMethod "getFamily" o = SocketGetFamilyMethodInfo ResolveSocketMethod "getFd" o = SocketGetFdMethodInfo ResolveSocketMethod "getKeepalive" o = SocketGetKeepaliveMethodInfo ResolveSocketMethod "getListenBacklog" o = SocketGetListenBacklogMethodInfo ResolveSocketMethod "getLocalAddress" o = SocketGetLocalAddressMethodInfo ResolveSocketMethod "getMulticastLoopback" o = SocketGetMulticastLoopbackMethodInfo ResolveSocketMethod "getMulticastTtl" o = SocketGetMulticastTtlMethodInfo ResolveSocketMethod "getOption" o = SocketGetOptionMethodInfo ResolveSocketMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo ResolveSocketMethod "getProtocol" o = SocketGetProtocolMethodInfo ResolveSocketMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo ResolveSocketMethod "getRemoteAddress" o = SocketGetRemoteAddressMethodInfo ResolveSocketMethod "getSocketType" o = SocketGetSocketTypeMethodInfo ResolveSocketMethod "getTimeout" o = SocketGetTimeoutMethodInfo ResolveSocketMethod "getTtl" o = SocketGetTtlMethodInfo ResolveSocketMethod "setBlocking" o = SocketSetBlockingMethodInfo ResolveSocketMethod "setBroadcast" o = SocketSetBroadcastMethodInfo ResolveSocketMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo ResolveSocketMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo ResolveSocketMethod "setKeepalive" o = SocketSetKeepaliveMethodInfo ResolveSocketMethod "setListenBacklog" o = SocketSetListenBacklogMethodInfo ResolveSocketMethod "setMulticastLoopback" o = SocketSetMulticastLoopbackMethodInfo ResolveSocketMethod "setMulticastTtl" o = SocketSetMulticastTtlMethodInfo ResolveSocketMethod "setOption" o = SocketSetOptionMethodInfo ResolveSocketMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo ResolveSocketMethod "setTimeout" o = SocketSetTimeoutMethodInfo ResolveSocketMethod "setTtl" o = SocketSetTtlMethodInfo ResolveSocketMethod l o = O.MethodResolutionFailed l o instance (info ~ ResolveSocketMethod t Socket, O.MethodInfo info Socket p) => OL.IsLabel t (Socket -> p) where #if MIN_VERSION_base(4,10,0) fromLabel = O.overloadedMethod @info #else fromLabel _ = O.overloadedMethod @info #endif #endif -- VVV Prop "blocking" -- Type: TBasicType TBoolean -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@blocking@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #blocking -- @ getSocketBlocking :: (MonadIO m, IsSocket o) => o -> m Bool getSocketBlocking obj = liftIO $ B.Properties.getObjectPropertyBool obj "blocking" -- | Set the value of the “@blocking@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #blocking 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketBlocking :: (MonadIO m, IsSocket o) => o -> Bool -> m () setSocketBlocking obj val = liftIO $ B.Properties.setObjectPropertyBool obj "blocking" val -- | Construct a `GValueConstruct` with valid value for the “@blocking@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketBlocking :: (IsSocket o) => Bool -> IO (GValueConstruct o) constructSocketBlocking val = B.Properties.constructObjectPropertyBool "blocking" val #if defined(ENABLE_OVERLOADING) data SocketBlockingPropertyInfo instance AttrInfo SocketBlockingPropertyInfo where type AttrAllowedOps SocketBlockingPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketBlockingPropertyInfo = IsSocket type AttrSetTypeConstraint SocketBlockingPropertyInfo = (~) Bool type AttrTransferTypeConstraint SocketBlockingPropertyInfo = (~) Bool type AttrTransferType SocketBlockingPropertyInfo = Bool type AttrGetType SocketBlockingPropertyInfo = Bool type AttrLabel SocketBlockingPropertyInfo = "blocking" type AttrOrigin SocketBlockingPropertyInfo = Socket attrGet = getSocketBlocking attrSet = setSocketBlocking attrTransfer _ v = do return v attrConstruct = constructSocketBlocking attrClear = undefined #endif -- VVV Prop "broadcast" -- Type: TBasicType TBoolean -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@broadcast@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #broadcast -- @ getSocketBroadcast :: (MonadIO m, IsSocket o) => o -> m Bool getSocketBroadcast obj = liftIO $ B.Properties.getObjectPropertyBool obj "broadcast" -- | Set the value of the “@broadcast@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #broadcast 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketBroadcast :: (MonadIO m, IsSocket o) => o -> Bool -> m () setSocketBroadcast obj val = liftIO $ B.Properties.setObjectPropertyBool obj "broadcast" val -- | Construct a `GValueConstruct` with valid value for the “@broadcast@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketBroadcast :: (IsSocket o) => Bool -> IO (GValueConstruct o) constructSocketBroadcast val = B.Properties.constructObjectPropertyBool "broadcast" val #if defined(ENABLE_OVERLOADING) data SocketBroadcastPropertyInfo instance AttrInfo SocketBroadcastPropertyInfo where type AttrAllowedOps SocketBroadcastPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketBroadcastPropertyInfo = IsSocket type AttrSetTypeConstraint SocketBroadcastPropertyInfo = (~) Bool type AttrTransferTypeConstraint SocketBroadcastPropertyInfo = (~) Bool type AttrTransferType SocketBroadcastPropertyInfo = Bool type AttrGetType SocketBroadcastPropertyInfo = Bool type AttrLabel SocketBroadcastPropertyInfo = "broadcast" type AttrOrigin SocketBroadcastPropertyInfo = Socket attrGet = getSocketBroadcast attrSet = setSocketBroadcast attrTransfer _ v = do return v attrConstruct = constructSocketBroadcast attrClear = undefined #endif -- VVV Prop "family" -- Type: TInterface (Name {namespace = "Gio", name = "SocketFamily"}) -- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly] -- Nullable: (Just False,Nothing) -- | Get the value of the “@family@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #family -- @ getSocketFamily :: (MonadIO m, IsSocket o) => o -> m Gio.Enums.SocketFamily getSocketFamily obj = liftIO $ B.Properties.getObjectPropertyEnum obj "family" -- | Construct a `GValueConstruct` with valid value for the “@family@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketFamily :: (IsSocket o) => Gio.Enums.SocketFamily -> IO (GValueConstruct o) constructSocketFamily val = B.Properties.constructObjectPropertyEnum "family" val #if defined(ENABLE_OVERLOADING) data SocketFamilyPropertyInfo instance AttrInfo SocketFamilyPropertyInfo where type AttrAllowedOps SocketFamilyPropertyInfo = '[ 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketFamilyPropertyInfo = IsSocket type AttrSetTypeConstraint SocketFamilyPropertyInfo = (~) Gio.Enums.SocketFamily type AttrTransferTypeConstraint SocketFamilyPropertyInfo = (~) Gio.Enums.SocketFamily type AttrTransferType SocketFamilyPropertyInfo = Gio.Enums.SocketFamily type AttrGetType SocketFamilyPropertyInfo = Gio.Enums.SocketFamily type AttrLabel SocketFamilyPropertyInfo = "family" type AttrOrigin SocketFamilyPropertyInfo = Socket attrGet = getSocketFamily attrSet = undefined attrTransfer _ v = do return v attrConstruct = constructSocketFamily attrClear = undefined #endif -- VVV Prop "fd" -- Type: TBasicType TInt -- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly] -- Nullable: (Just False,Nothing) -- | Get the value of the “@fd@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #fd -- @ getSocketFd :: (MonadIO m, IsSocket o) => o -> m Int32 getSocketFd obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "fd" -- | Construct a `GValueConstruct` with valid value for the “@fd@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketFd :: (IsSocket o) => Int32 -> IO (GValueConstruct o) constructSocketFd val = B.Properties.constructObjectPropertyInt32 "fd" val #if defined(ENABLE_OVERLOADING) data SocketFdPropertyInfo instance AttrInfo SocketFdPropertyInfo where type AttrAllowedOps SocketFdPropertyInfo = '[ 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketFdPropertyInfo = IsSocket type AttrSetTypeConstraint SocketFdPropertyInfo = (~) Int32 type AttrTransferTypeConstraint SocketFdPropertyInfo = (~) Int32 type AttrTransferType SocketFdPropertyInfo = Int32 type AttrGetType SocketFdPropertyInfo = Int32 type AttrLabel SocketFdPropertyInfo = "fd" type AttrOrigin SocketFdPropertyInfo = Socket attrGet = getSocketFd attrSet = undefined attrTransfer _ v = do return v attrConstruct = constructSocketFd attrClear = undefined #endif -- VVV Prop "keepalive" -- Type: TBasicType TBoolean -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@keepalive@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #keepalive -- @ getSocketKeepalive :: (MonadIO m, IsSocket o) => o -> m Bool getSocketKeepalive obj = liftIO $ B.Properties.getObjectPropertyBool obj "keepalive" -- | Set the value of the “@keepalive@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #keepalive 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketKeepalive :: (MonadIO m, IsSocket o) => o -> Bool -> m () setSocketKeepalive obj val = liftIO $ B.Properties.setObjectPropertyBool obj "keepalive" val -- | Construct a `GValueConstruct` with valid value for the “@keepalive@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketKeepalive :: (IsSocket o) => Bool -> IO (GValueConstruct o) constructSocketKeepalive val = B.Properties.constructObjectPropertyBool "keepalive" val #if defined(ENABLE_OVERLOADING) data SocketKeepalivePropertyInfo instance AttrInfo SocketKeepalivePropertyInfo where type AttrAllowedOps SocketKeepalivePropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketKeepalivePropertyInfo = IsSocket type AttrSetTypeConstraint SocketKeepalivePropertyInfo = (~) Bool type AttrTransferTypeConstraint SocketKeepalivePropertyInfo = (~) Bool type AttrTransferType SocketKeepalivePropertyInfo = Bool type AttrGetType SocketKeepalivePropertyInfo = Bool type AttrLabel SocketKeepalivePropertyInfo = "keepalive" type AttrOrigin SocketKeepalivePropertyInfo = Socket attrGet = getSocketKeepalive attrSet = setSocketKeepalive attrTransfer _ v = do return v attrConstruct = constructSocketKeepalive attrClear = undefined #endif -- VVV Prop "listen-backlog" -- Type: TBasicType TInt -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@listen-backlog@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #listenBacklog -- @ getSocketListenBacklog :: (MonadIO m, IsSocket o) => o -> m Int32 getSocketListenBacklog obj = liftIO $ B.Properties.getObjectPropertyInt32 obj "listen-backlog" -- | Set the value of the “@listen-backlog@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #listenBacklog 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketListenBacklog :: (MonadIO m, IsSocket o) => o -> Int32 -> m () setSocketListenBacklog obj val = liftIO $ B.Properties.setObjectPropertyInt32 obj "listen-backlog" val -- | Construct a `GValueConstruct` with valid value for the “@listen-backlog@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketListenBacklog :: (IsSocket o) => Int32 -> IO (GValueConstruct o) constructSocketListenBacklog val = B.Properties.constructObjectPropertyInt32 "listen-backlog" val #if defined(ENABLE_OVERLOADING) data SocketListenBacklogPropertyInfo instance AttrInfo SocketListenBacklogPropertyInfo where type AttrAllowedOps SocketListenBacklogPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketListenBacklogPropertyInfo = IsSocket type AttrSetTypeConstraint SocketListenBacklogPropertyInfo = (~) Int32 type AttrTransferTypeConstraint SocketListenBacklogPropertyInfo = (~) Int32 type AttrTransferType SocketListenBacklogPropertyInfo = Int32 type AttrGetType SocketListenBacklogPropertyInfo = Int32 type AttrLabel SocketListenBacklogPropertyInfo = "listen-backlog" type AttrOrigin SocketListenBacklogPropertyInfo = Socket attrGet = getSocketListenBacklog attrSet = setSocketListenBacklog attrTransfer _ v = do return v attrConstruct = constructSocketListenBacklog attrClear = undefined #endif -- VVV Prop "local-address" -- Type: TInterface (Name {namespace = "Gio", name = "SocketAddress"}) -- Flags: [PropertyReadable] -- Nullable: (Nothing,Nothing) -- | Get the value of the “@local-address@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #localAddress -- @ getSocketLocalAddress :: (MonadIO m, IsSocket o) => o -> m (Maybe Gio.SocketAddress.SocketAddress) getSocketLocalAddress obj = liftIO $ B.Properties.getObjectPropertyObject obj "local-address" Gio.SocketAddress.SocketAddress #if defined(ENABLE_OVERLOADING) data SocketLocalAddressPropertyInfo instance AttrInfo SocketLocalAddressPropertyInfo where type AttrAllowedOps SocketLocalAddressPropertyInfo = '[ 'AttrGet, 'AttrClear] type AttrBaseTypeConstraint SocketLocalAddressPropertyInfo = IsSocket type AttrSetTypeConstraint SocketLocalAddressPropertyInfo = (~) () type AttrTransferTypeConstraint SocketLocalAddressPropertyInfo = (~) () type AttrTransferType SocketLocalAddressPropertyInfo = () type AttrGetType SocketLocalAddressPropertyInfo = (Maybe Gio.SocketAddress.SocketAddress) type AttrLabel SocketLocalAddressPropertyInfo = "local-address" type AttrOrigin SocketLocalAddressPropertyInfo = Socket attrGet = getSocketLocalAddress attrSet = undefined attrTransfer _ = undefined attrConstruct = undefined attrClear = undefined #endif -- VVV Prop "multicast-loopback" -- Type: TBasicType TBoolean -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@multicast-loopback@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #multicastLoopback -- @ getSocketMulticastLoopback :: (MonadIO m, IsSocket o) => o -> m Bool getSocketMulticastLoopback obj = liftIO $ B.Properties.getObjectPropertyBool obj "multicast-loopback" -- | Set the value of the “@multicast-loopback@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #multicastLoopback 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketMulticastLoopback :: (MonadIO m, IsSocket o) => o -> Bool -> m () setSocketMulticastLoopback obj val = liftIO $ B.Properties.setObjectPropertyBool obj "multicast-loopback" val -- | Construct a `GValueConstruct` with valid value for the “@multicast-loopback@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketMulticastLoopback :: (IsSocket o) => Bool -> IO (GValueConstruct o) constructSocketMulticastLoopback val = B.Properties.constructObjectPropertyBool "multicast-loopback" val #if defined(ENABLE_OVERLOADING) data SocketMulticastLoopbackPropertyInfo instance AttrInfo SocketMulticastLoopbackPropertyInfo where type AttrAllowedOps SocketMulticastLoopbackPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketMulticastLoopbackPropertyInfo = IsSocket type AttrSetTypeConstraint SocketMulticastLoopbackPropertyInfo = (~) Bool type AttrTransferTypeConstraint SocketMulticastLoopbackPropertyInfo = (~) Bool type AttrTransferType SocketMulticastLoopbackPropertyInfo = Bool type AttrGetType SocketMulticastLoopbackPropertyInfo = Bool type AttrLabel SocketMulticastLoopbackPropertyInfo = "multicast-loopback" type AttrOrigin SocketMulticastLoopbackPropertyInfo = Socket attrGet = getSocketMulticastLoopback attrSet = setSocketMulticastLoopback attrTransfer _ v = do return v attrConstruct = constructSocketMulticastLoopback attrClear = undefined #endif -- VVV Prop "multicast-ttl" -- Type: TBasicType TUInt -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@multicast-ttl@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #multicastTtl -- @ getSocketMulticastTtl :: (MonadIO m, IsSocket o) => o -> m Word32 getSocketMulticastTtl obj = liftIO $ B.Properties.getObjectPropertyUInt32 obj "multicast-ttl" -- | Set the value of the “@multicast-ttl@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #multicastTtl 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketMulticastTtl :: (MonadIO m, IsSocket o) => o -> Word32 -> m () setSocketMulticastTtl obj val = liftIO $ B.Properties.setObjectPropertyUInt32 obj "multicast-ttl" val -- | Construct a `GValueConstruct` with valid value for the “@multicast-ttl@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketMulticastTtl :: (IsSocket o) => Word32 -> IO (GValueConstruct o) constructSocketMulticastTtl val = B.Properties.constructObjectPropertyUInt32 "multicast-ttl" val #if defined(ENABLE_OVERLOADING) data SocketMulticastTtlPropertyInfo instance AttrInfo SocketMulticastTtlPropertyInfo where type AttrAllowedOps SocketMulticastTtlPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketMulticastTtlPropertyInfo = IsSocket type AttrSetTypeConstraint SocketMulticastTtlPropertyInfo = (~) Word32 type AttrTransferTypeConstraint SocketMulticastTtlPropertyInfo = (~) Word32 type AttrTransferType SocketMulticastTtlPropertyInfo = Word32 type AttrGetType SocketMulticastTtlPropertyInfo = Word32 type AttrLabel SocketMulticastTtlPropertyInfo = "multicast-ttl" type AttrOrigin SocketMulticastTtlPropertyInfo = Socket attrGet = getSocketMulticastTtl attrSet = setSocketMulticastTtl attrTransfer _ v = do return v attrConstruct = constructSocketMulticastTtl attrClear = undefined #endif -- VVV Prop "protocol" -- Type: TInterface (Name {namespace = "Gio", name = "SocketProtocol"}) -- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly] -- Nullable: (Just False,Nothing) -- | Get the value of the “@protocol@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #protocol -- @ getSocketProtocol :: (MonadIO m, IsSocket o) => o -> m Gio.Enums.SocketProtocol getSocketProtocol obj = liftIO $ B.Properties.getObjectPropertyEnum obj "protocol" -- | Construct a `GValueConstruct` with valid value for the “@protocol@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketProtocol :: (IsSocket o) => Gio.Enums.SocketProtocol -> IO (GValueConstruct o) constructSocketProtocol val = B.Properties.constructObjectPropertyEnum "protocol" val #if defined(ENABLE_OVERLOADING) data SocketProtocolPropertyInfo instance AttrInfo SocketProtocolPropertyInfo where type AttrAllowedOps SocketProtocolPropertyInfo = '[ 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketProtocolPropertyInfo = IsSocket type AttrSetTypeConstraint SocketProtocolPropertyInfo = (~) Gio.Enums.SocketProtocol type AttrTransferTypeConstraint SocketProtocolPropertyInfo = (~) Gio.Enums.SocketProtocol type AttrTransferType SocketProtocolPropertyInfo = Gio.Enums.SocketProtocol type AttrGetType SocketProtocolPropertyInfo = Gio.Enums.SocketProtocol type AttrLabel SocketProtocolPropertyInfo = "protocol" type AttrOrigin SocketProtocolPropertyInfo = Socket attrGet = getSocketProtocol attrSet = undefined attrTransfer _ v = do return v attrConstruct = constructSocketProtocol attrClear = undefined #endif -- VVV Prop "remote-address" -- Type: TInterface (Name {namespace = "Gio", name = "SocketAddress"}) -- Flags: [PropertyReadable] -- Nullable: (Nothing,Nothing) -- | Get the value of the “@remote-address@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #remoteAddress -- @ getSocketRemoteAddress :: (MonadIO m, IsSocket o) => o -> m (Maybe Gio.SocketAddress.SocketAddress) getSocketRemoteAddress obj = liftIO $ B.Properties.getObjectPropertyObject obj "remote-address" Gio.SocketAddress.SocketAddress #if defined(ENABLE_OVERLOADING) data SocketRemoteAddressPropertyInfo instance AttrInfo SocketRemoteAddressPropertyInfo where type AttrAllowedOps SocketRemoteAddressPropertyInfo = '[ 'AttrGet, 'AttrClear] type AttrBaseTypeConstraint SocketRemoteAddressPropertyInfo = IsSocket type AttrSetTypeConstraint SocketRemoteAddressPropertyInfo = (~) () type AttrTransferTypeConstraint SocketRemoteAddressPropertyInfo = (~) () type AttrTransferType SocketRemoteAddressPropertyInfo = () type AttrGetType SocketRemoteAddressPropertyInfo = (Maybe Gio.SocketAddress.SocketAddress) type AttrLabel SocketRemoteAddressPropertyInfo = "remote-address" type AttrOrigin SocketRemoteAddressPropertyInfo = Socket attrGet = getSocketRemoteAddress attrSet = undefined attrTransfer _ = undefined attrConstruct = undefined attrClear = undefined #endif -- VVV Prop "timeout" -- Type: TBasicType TUInt -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@timeout@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #timeout -- @ getSocketTimeout :: (MonadIO m, IsSocket o) => o -> m Word32 getSocketTimeout obj = liftIO $ B.Properties.getObjectPropertyUInt32 obj "timeout" -- | Set the value of the “@timeout@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #timeout 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketTimeout :: (MonadIO m, IsSocket o) => o -> Word32 -> m () setSocketTimeout obj val = liftIO $ B.Properties.setObjectPropertyUInt32 obj "timeout" val -- | Construct a `GValueConstruct` with valid value for the “@timeout@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketTimeout :: (IsSocket o) => Word32 -> IO (GValueConstruct o) constructSocketTimeout val = B.Properties.constructObjectPropertyUInt32 "timeout" val #if defined(ENABLE_OVERLOADING) data SocketTimeoutPropertyInfo instance AttrInfo SocketTimeoutPropertyInfo where type AttrAllowedOps SocketTimeoutPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketTimeoutPropertyInfo = IsSocket type AttrSetTypeConstraint SocketTimeoutPropertyInfo = (~) Word32 type AttrTransferTypeConstraint SocketTimeoutPropertyInfo = (~) Word32 type AttrTransferType SocketTimeoutPropertyInfo = Word32 type AttrGetType SocketTimeoutPropertyInfo = Word32 type AttrLabel SocketTimeoutPropertyInfo = "timeout" type AttrOrigin SocketTimeoutPropertyInfo = Socket attrGet = getSocketTimeout attrSet = setSocketTimeout attrTransfer _ v = do return v attrConstruct = constructSocketTimeout attrClear = undefined #endif -- VVV Prop "ttl" -- Type: TBasicType TUInt -- Flags: [PropertyReadable,PropertyWritable] -- Nullable: (Just False,Just False) -- | Get the value of the “@ttl@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #ttl -- @ getSocketTtl :: (MonadIO m, IsSocket o) => o -> m Word32 getSocketTtl obj = liftIO $ B.Properties.getObjectPropertyUInt32 obj "ttl" -- | Set the value of the “@ttl@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.set' socket [ #ttl 'Data.GI.Base.Attributes.:=' value ] -- @ setSocketTtl :: (MonadIO m, IsSocket o) => o -> Word32 -> m () setSocketTtl obj val = liftIO $ B.Properties.setObjectPropertyUInt32 obj "ttl" val -- | Construct a `GValueConstruct` with valid value for the “@ttl@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketTtl :: (IsSocket o) => Word32 -> IO (GValueConstruct o) constructSocketTtl val = B.Properties.constructObjectPropertyUInt32 "ttl" val #if defined(ENABLE_OVERLOADING) data SocketTtlPropertyInfo instance AttrInfo SocketTtlPropertyInfo where type AttrAllowedOps SocketTtlPropertyInfo = '[ 'AttrSet, 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketTtlPropertyInfo = IsSocket type AttrSetTypeConstraint SocketTtlPropertyInfo = (~) Word32 type AttrTransferTypeConstraint SocketTtlPropertyInfo = (~) Word32 type AttrTransferType SocketTtlPropertyInfo = Word32 type AttrGetType SocketTtlPropertyInfo = Word32 type AttrLabel SocketTtlPropertyInfo = "ttl" type AttrOrigin SocketTtlPropertyInfo = Socket attrGet = getSocketTtl attrSet = setSocketTtl attrTransfer _ v = do return v attrConstruct = constructSocketTtl attrClear = undefined #endif -- VVV Prop "type" -- Type: TInterface (Name {namespace = "Gio", name = "SocketType"}) -- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly] -- Nullable: (Nothing,Nothing) -- | Get the value of the “@type@” property. -- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to -- -- @ -- 'Data.GI.Base.Attributes.get' socket #type -- @ getSocketType :: (MonadIO m, IsSocket o) => o -> m Gio.Enums.SocketType getSocketType obj = liftIO $ B.Properties.getObjectPropertyEnum obj "type" -- | Construct a `GValueConstruct` with valid value for the “@type@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`. constructSocketType :: (IsSocket o) => Gio.Enums.SocketType -> IO (GValueConstruct o) constructSocketType val = B.Properties.constructObjectPropertyEnum "type" val #if defined(ENABLE_OVERLOADING) data SocketTypePropertyInfo instance AttrInfo SocketTypePropertyInfo where type AttrAllowedOps SocketTypePropertyInfo = '[ 'AttrConstruct, 'AttrGet] type AttrBaseTypeConstraint SocketTypePropertyInfo = IsSocket type AttrSetTypeConstraint SocketTypePropertyInfo = (~) Gio.Enums.SocketType type AttrTransferTypeConstraint SocketTypePropertyInfo = (~) Gio.Enums.SocketType type AttrTransferType SocketTypePropertyInfo = Gio.Enums.SocketType type AttrGetType SocketTypePropertyInfo = Gio.Enums.SocketType type AttrLabel SocketTypePropertyInfo = "type" type AttrOrigin SocketTypePropertyInfo = Socket attrGet = getSocketType attrSet = undefined attrTransfer _ v = do return v attrConstruct = constructSocketType attrClear = undefined #endif #if defined(ENABLE_OVERLOADING) instance O.HasAttributeList Socket type instance O.AttributeList Socket = SocketAttributeList type SocketAttributeList = ('[ '("blocking", SocketBlockingPropertyInfo), '("broadcast", SocketBroadcastPropertyInfo), '("family", SocketFamilyPropertyInfo), '("fd", SocketFdPropertyInfo), '("keepalive", SocketKeepalivePropertyInfo), '("listenBacklog", SocketListenBacklogPropertyInfo), '("localAddress", SocketLocalAddressPropertyInfo), '("multicastLoopback", SocketMulticastLoopbackPropertyInfo), '("multicastTtl", SocketMulticastTtlPropertyInfo), '("protocol", SocketProtocolPropertyInfo), '("remoteAddress", SocketRemoteAddressPropertyInfo), '("timeout", SocketTimeoutPropertyInfo), '("ttl", SocketTtlPropertyInfo), '("type", SocketTypePropertyInfo)] :: [(Symbol, *)]) #endif #if defined(ENABLE_OVERLOADING) socketBlocking :: AttrLabelProxy "blocking" socketBlocking = AttrLabelProxy socketBroadcast :: AttrLabelProxy "broadcast" socketBroadcast = AttrLabelProxy socketFamily :: AttrLabelProxy "family" socketFamily = AttrLabelProxy socketFd :: AttrLabelProxy "fd" socketFd = AttrLabelProxy socketKeepalive :: AttrLabelProxy "keepalive" socketKeepalive = AttrLabelProxy socketListenBacklog :: AttrLabelProxy "listenBacklog" socketListenBacklog = AttrLabelProxy socketLocalAddress :: AttrLabelProxy "localAddress" socketLocalAddress = AttrLabelProxy socketMulticastLoopback :: AttrLabelProxy "multicastLoopback" socketMulticastLoopback = AttrLabelProxy socketMulticastTtl :: AttrLabelProxy "multicastTtl" socketMulticastTtl = AttrLabelProxy socketProtocol :: AttrLabelProxy "protocol" socketProtocol = AttrLabelProxy socketRemoteAddress :: AttrLabelProxy "remoteAddress" socketRemoteAddress = AttrLabelProxy socketTimeout :: AttrLabelProxy "timeout" socketTimeout = AttrLabelProxy socketTtl :: AttrLabelProxy "ttl" socketTtl = AttrLabelProxy socketType :: AttrLabelProxy "type" socketType = AttrLabelProxy #endif #if defined(ENABLE_OVERLOADING) type instance O.SignalList Socket = SocketSignalList type SocketSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)]) #endif -- method Socket::new -- method type : Constructor -- Args: [ Arg -- { argCName = "family" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketFamily" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "type" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketType" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the socket type to use." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "protocol" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketProtocol" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the id of the protocol to use, or 0 for default." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "Gio" , name = "Socket" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_new" g_socket_new :: CUInt -> -- family : TInterface (Name {namespace = "Gio", name = "SocketFamily"}) CUInt -> -- type : TInterface (Name {namespace = "Gio", name = "SocketType"}) CInt -> -- protocol : TInterface (Name {namespace = "Gio", name = "SocketProtocol"}) Ptr (Ptr GError) -> -- error IO (Ptr Socket) -- | Creates a new t'GI.Gio.Objects.Socket.Socket' with the defined family, type and protocol. -- If /@protocol@/ is 0 ('GI.Gio.Enums.SocketProtocolDefault') the default protocol type -- for the family and type is used. -- -- The /@protocol@/ is a family and type specific int that specifies what -- kind of protocol to use. t'GI.Gio.Enums.SocketProtocol' lists several common ones. -- Many families only support one protocol, and use 0 for this, others -- support several and using 0 means to use the default protocol for -- the family and type. -- -- The protocol id is passed directly to the operating -- system, so you can use protocols not listed in t'GI.Gio.Enums.SocketProtocol' if you -- know the protocol number used for it. -- -- /Since: 2.22/ socketNew :: (B.CallStack.HasCallStack, MonadIO m) => Gio.Enums.SocketFamily -- ^ /@family@/: the socket family to use, e.g. 'GI.Gio.Enums.SocketFamilyIpv4'. -> Gio.Enums.SocketType -- ^ /@type@/: the socket type to use. -> Gio.Enums.SocketProtocol -- ^ /@protocol@/: the id of the protocol to use, or 0 for default. -> m Socket -- ^ __Returns:__ a t'GI.Gio.Objects.Socket.Socket' or 'P.Nothing' on error. -- Free the returned object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketNew family type_ protocol = liftIO $ do let family' = (fromIntegral . fromEnum) family let type_' = (fromIntegral . fromEnum) type_ let protocol' = (fromIntegral . fromEnum) protocol onException (do result <- propagateGError $ g_socket_new family' type_' protocol' checkUnexpectedReturnNULL "socketNew" result result' <- (wrapObject Socket) result return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) #endif -- method Socket::new_from_fd -- method type : Constructor -- Args: [ Arg -- { argCName = "fd" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a native socket file descriptor." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "Gio" , name = "Socket" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_new_from_fd" g_socket_new_from_fd :: Int32 -> -- fd : TBasicType TInt Ptr (Ptr GError) -> -- error IO (Ptr Socket) -- | Creates a new t'GI.Gio.Objects.Socket.Socket' from a native file descriptor -- or winsock SOCKET handle. -- -- This reads all the settings from the file descriptor so that -- all properties should work. Note that the file descriptor -- will be set to non-blocking mode, independent on the blocking -- mode of the t'GI.Gio.Objects.Socket.Socket'. -- -- On success, the returned t'GI.Gio.Objects.Socket.Socket' takes ownership of /@fd@/. On failure, the -- caller must close /@fd@/ themselves. -- -- Since GLib 2.46, it is no longer a fatal error to call this on a non-socket -- descriptor. Instead, a GError will be set with code 'GI.Gio.Enums.IOErrorEnumFailed' -- -- /Since: 2.22/ socketNewFromFd :: (B.CallStack.HasCallStack, MonadIO m) => Int32 -- ^ /@fd@/: a native socket file descriptor. -> m Socket -- ^ __Returns:__ a t'GI.Gio.Objects.Socket.Socket' or 'P.Nothing' on error. -- Free the returned object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketNewFromFd fd = liftIO $ do onException (do result <- propagateGError $ g_socket_new_from_fd fd checkUnexpectedReturnNULL "socketNewFromFd" result result' <- (wrapObject Socket) result return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) #endif -- method Socket::accept -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "Gio" , name = "Socket" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_accept" g_socket_accept :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO (Ptr Socket) -- | Accept incoming connections on a connection-based socket. This removes -- the first outstanding connection request from the listening socket and -- creates a t'GI.Gio.Objects.Socket.Socket' object for it. -- -- The /@socket@/ must be bound to a local address with 'GI.Gio.Objects.Socket.socketBind' and -- must be listening for incoming connections ('GI.Gio.Objects.Socket.socketListen'). -- -- If there are no outstanding connections then the operation will block -- or return 'GI.Gio.Enums.IOErrorEnumWouldBlock' if non-blocking I\/O is enabled. -- To be notified of an incoming connection, wait for the 'GI.GLib.Flags.IOConditionIn' condition. -- -- /Since: 2.22/ socketAccept :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Socket -- ^ __Returns:__ a new t'GI.Gio.Objects.Socket.Socket', or 'P.Nothing' on error. -- Free the returned object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketAccept socket cancellable = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_accept socket' maybeCancellable checkUnexpectedReturnNULL "socketAccept" result result' <- (wrapObject Socket) result touchManagedPtr socket whenJust cancellable touchManagedPtr return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketAcceptMethodInfo instance (signature ~ (Maybe (b) -> m Socket), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketAcceptMethodInfo a signature where overloadedMethod = socketAccept #endif -- method Socket::bind -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GSocketAddress specifying the local address." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "allow_reuse" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "whether to allow reusing this address" -- , 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_bind" g_socket_bind :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.SocketAddress.SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) CInt -> -- allow_reuse : TBasicType TBoolean Ptr (Ptr GError) -> -- error IO CInt -- | When a socket is created it is attached to an address family, but it -- doesn\'t have an address in this family. 'GI.Gio.Objects.Socket.socketBind' assigns the -- address (sometimes called name) of the socket. -- -- It is generally required to bind to a local address before you can -- receive connections. (See 'GI.Gio.Objects.Socket.socketListen' and 'GI.Gio.Objects.Socket.socketAccept' ). -- In certain situations, you may also want to bind a socket that will be -- used to initiate connections, though this is not normally required. -- -- If /@socket@/ is a TCP socket, then /@allowReuse@/ controls the setting -- of the @SO_REUSEADDR@ socket option; normally it should be 'P.True' for -- server sockets (sockets that you will eventually call -- 'GI.Gio.Objects.Socket.socketAccept' on), and 'P.False' for client sockets. (Failing to -- set this flag on a server socket may cause 'GI.Gio.Objects.Socket.socketBind' to return -- 'GI.Gio.Enums.IOErrorEnumAddressInUse' if the server program is stopped and then -- immediately restarted.) -- -- If /@socket@/ is a UDP socket, then /@allowReuse@/ determines whether or -- not other UDP sockets can be bound to the same address at the same -- time. In particular, you can have several UDP sockets bound to the -- same address, and they will all receive all of the multicast and -- broadcast packets sent to that address. (The behavior of unicast -- UDP packets to an address with multiple listeners is not defined.) -- -- /Since: 2.22/ socketBind :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@address@/: a t'GI.Gio.Objects.SocketAddress.SocketAddress' specifying the local address. -> Bool -- ^ /@allowReuse@/: whether to allow reusing this address -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketBind socket address allowReuse = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket address' <- unsafeManagedPtrCastPtr address let allowReuse' = (fromIntegral . fromEnum) allowReuse onException (do _ <- propagateGError $ g_socket_bind socket' address' allowReuse' touchManagedPtr socket touchManagedPtr address return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketBindMethodInfo instance (signature ~ (b -> Bool -> m ()), MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b) => O.MethodInfo SocketBindMethodInfo a signature where overloadedMethod = socketBind #endif -- method Socket::check_connect_result -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , 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_check_connect_result" g_socket_check_connect_result :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO CInt -- | Checks and resets the pending connect error for the socket. -- This is used to check for errors when 'GI.Gio.Objects.Socket.socketConnect' is -- used in non-blocking mode. -- -- /Since: 2.22/ socketCheckConnectResult :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketCheckConnectResult socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do _ <- propagateGError $ g_socket_check_connect_result socket' touchManagedPtr socket return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketCheckConnectResultMethodInfo instance (signature ~ (m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketCheckConnectResultMethodInfo a signature where overloadedMethod = socketCheckConnectResult #endif -- method Socket::close -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , 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_close" g_socket_close :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO CInt -- | Closes the socket, shutting down any active connection. -- -- Closing a socket does not wait for all outstanding I\/O operations -- to finish, so the caller should not rely on them to be guaranteed -- to complete even if the close returns with no error. -- -- Once the socket is closed, all other operations will return -- 'GI.Gio.Enums.IOErrorEnumClosed'. Closing a socket multiple times will not -- return an error. -- -- Sockets will be automatically closed when the last reference -- is dropped, but you might want to call this function to make sure -- resources are released as early as possible. -- -- Beware that due to the way that TCP works, it is possible for -- recently-sent data to be lost if either you close a socket while the -- 'GI.GLib.Flags.IOConditionIn' condition is set, or else if the remote connection tries to -- send something to you after you close the socket but before it has -- finished reading all of the data you sent. There is no easy generic -- way to avoid this problem; the easiest fix is to design the network -- protocol such that the client will never send data \"out of turn\". -- Another solution is for the server to half-close the connection by -- calling 'GI.Gio.Objects.Socket.socketShutdown' with only the /@shutdownWrite@/ flag set, -- and then wait for the client to notice this and close its side of the -- connection, after which the server can safely call 'GI.Gio.Objects.Socket.socketClose'. -- (This is what t'GI.Gio.Objects.TcpConnection.TcpConnection' does if you call -- 'GI.Gio.Objects.TcpConnection.tcpConnectionSetGracefulDisconnect'. But of course, this -- only works if the client will close its connection after the server -- does.) -- -- /Since: 2.22/ socketClose :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketClose socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do _ <- propagateGError $ g_socket_close socket' touchManagedPtr socket return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketCloseMethodInfo instance (signature ~ (m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketCloseMethodInfo a signature where overloadedMethod = socketClose #endif -- method Socket::condition_check -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "GLib" , name = "IOCondition" }) -- throws : False -- Skip return : False foreign import ccall "g_socket_condition_check" g_socket_condition_check :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) IO CUInt -- | Checks on the readiness of /@socket@/ to perform operations. -- The operations specified in /@condition@/ are checked for and masked -- against the currently-satisfied conditions on /@socket@/. The result -- is returned. -- -- Note that on Windows, it is possible for an operation to return -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' even immediately after -- 'GI.Gio.Objects.Socket.socketConditionCheck' has claimed that the socket is ready for -- writing. Rather than calling 'GI.Gio.Objects.Socket.socketConditionCheck' and then -- writing to the socket if it succeeds, it is generally better to -- simply try writing to the socket right away, and try again later if -- the initial attempt returns 'GI.Gio.Enums.IOErrorEnumWouldBlock'. -- -- It is meaningless to specify 'GI.GLib.Flags.IOConditionErr' or 'GI.GLib.Flags.IOConditionHup' in condition; -- these conditions will always be set in the output if they are true. -- -- This call never blocks. -- -- /Since: 2.22/ socketConditionCheck :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GLib.Flags.IOCondition' mask to check -> m [GLib.Flags.IOCondition] -- ^ __Returns:__ the /@gIOCondition@/ mask of the current state socketConditionCheck socket condition = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let condition' = gflagsToWord condition result <- g_socket_condition_check socket' condition' let result' = wordToGFlags result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketConditionCheckMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> m [GLib.Flags.IOCondition]), MonadIO m, IsSocket a) => O.MethodInfo SocketConditionCheckMethodInfo a signature where overloadedMethod = socketConditionCheck #endif -- method Socket::condition_timed_wait -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout_us" -- , argType = TBasicType TInt64 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the maximum time (in microseconds) to wait, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GCancellable, or %NULL" -- , 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_condition_timed_wait" g_socket_condition_timed_wait :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) Int64 -> -- timeout_us : TBasicType TInt64 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO CInt -- | Waits for up to /@timeoutUs@/ microseconds for /@condition@/ to become true -- on /@socket@/. If the condition is met, 'P.True' is returned. -- -- If /@cancellable@/ is cancelled before the condition is met, or if -- /@timeoutUs@/ (or the socket\'s t'GI.Gio.Objects.Socket.Socket':@/timeout/@) is reached before the -- condition is met, then 'P.False' is returned and /@error@/, if non-'P.Nothing', -- is set to the appropriate value ('GI.Gio.Enums.IOErrorEnumCancelled' or -- 'GI.Gio.Enums.IOErrorEnumTimedOut'). -- -- If you don\'t want a timeout, use 'GI.Gio.Objects.Socket.socketConditionWait'. -- (Alternatively, you can pass -1 for /@timeoutUs@/.) -- -- Note that although /@timeoutUs@/ is in microseconds for consistency with -- other GLib APIs, this function actually only has millisecond -- resolution, and the behavior is undefined if /@timeoutUs@/ is not an -- exact number of milliseconds. -- -- /Since: 2.32/ socketConditionTimedWait :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GLib.Flags.IOCondition' mask to wait for -> Int64 -- ^ /@timeoutUs@/: the maximum time (in microseconds) to wait, or -1 -> Maybe (b) -- ^ /@cancellable@/: a t'GI.Gio.Objects.Cancellable.Cancellable', or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketConditionTimedWait socket condition timeoutUs cancellable = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let condition' = gflagsToWord condition maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do _ <- propagateGError $ g_socket_condition_timed_wait socket' condition' timeoutUs maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketConditionTimedWaitMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> Int64 -> Maybe (b) -> m ()), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketConditionTimedWaitMethodInfo a signature where overloadedMethod = socketConditionTimedWait #endif -- method Socket::condition_wait -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GCancellable, or %NULL" -- , 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_condition_wait" g_socket_condition_wait :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CUInt -> -- condition : TInterface (Name {namespace = "GLib", name = "IOCondition"}) Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO CInt -- | Waits for /@condition@/ to become true on /@socket@/. When the condition -- is met, 'P.True' is returned. -- -- If /@cancellable@/ is cancelled before the condition is met, or if the -- socket has a timeout set and it is reached before the condition is -- met, then 'P.False' is returned and /@error@/, if non-'P.Nothing', is set to -- the appropriate value ('GI.Gio.Enums.IOErrorEnumCancelled' or -- 'GI.Gio.Enums.IOErrorEnumTimedOut'). -- -- See also 'GI.Gio.Objects.Socket.socketConditionTimedWait'. -- -- /Since: 2.22/ socketConditionWait :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [GLib.Flags.IOCondition] -- ^ /@condition@/: a t'GI.GLib.Flags.IOCondition' mask to wait for -> Maybe (b) -- ^ /@cancellable@/: a t'GI.Gio.Objects.Cancellable.Cancellable', or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketConditionWait socket condition cancellable = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let condition' = gflagsToWord condition maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do _ <- propagateGError $ g_socket_condition_wait socket' condition' maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketConditionWaitMethodInfo instance (signature ~ ([GLib.Flags.IOCondition] -> Maybe (b) -> m ()), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketConditionWaitMethodInfo a signature where overloadedMethod = socketConditionWait #endif -- method Socket::connect -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GSocketAddress specifying the remote address." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , 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_connect" g_socket_connect :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.SocketAddress.SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO CInt -- | Connect the socket to the specified remote address. -- -- For connection oriented socket this generally means we attempt to make -- a connection to the /@address@/. For a connection-less socket it sets -- the default address for 'GI.Gio.Objects.Socket.socketSend' and discards all incoming datagrams -- from other sources. -- -- Generally connection oriented sockets can only connect once, but -- connection-less sockets can connect multiple times to change the -- default address. -- -- If the connect call needs to do network I\/O it will block, unless -- non-blocking I\/O is enabled. Then 'GI.Gio.Enums.IOErrorEnumPending' is returned -- and the user can be notified of the connection finishing by waiting -- for the G_IO_OUT condition. The result of the connection must then be -- checked with 'GI.Gio.Objects.Socket.socketCheckConnectResult'. -- -- /Since: 2.22/ socketConnect :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@address@/: a t'GI.Gio.Objects.SocketAddress.SocketAddress' specifying the remote address. -> Maybe (c) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketConnect socket address cancellable = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket address' <- unsafeManagedPtrCastPtr address maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do _ <- propagateGError $ g_socket_connect socket' address' maybeCancellable touchManagedPtr socket touchManagedPtr address whenJust cancellable touchManagedPtr return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketConnectMethodInfo instance (signature ~ (b -> Maybe (c) -> m ()), MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => O.MethodInfo SocketConnectMethodInfo a signature where overloadedMethod = socketConnect #endif -- method Socket::connection_factory_create_connection -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "Gio" , name = "SocketConnection" }) -- throws : False -- Skip return : False foreign import ccall "g_socket_connection_factory_create_connection" g_socket_connection_factory_create_connection :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO (Ptr Gio.SocketConnection.SocketConnection) -- | Creates a t'GI.Gio.Objects.SocketConnection.SocketConnection' subclass of the right type for -- /@socket@/. -- -- /Since: 2.22/ socketConnectionFactoryCreateConnection :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m Gio.SocketConnection.SocketConnection -- ^ __Returns:__ a t'GI.Gio.Objects.SocketConnection.SocketConnection' socketConnectionFactoryCreateConnection socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_connection_factory_create_connection socket' checkUnexpectedReturnNULL "socketConnectionFactoryCreateConnection" result result' <- (wrapObject Gio.SocketConnection.SocketConnection) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketConnectionFactoryCreateConnectionMethodInfo instance (signature ~ (m Gio.SocketConnection.SocketConnection), MonadIO m, IsSocket a) => O.MethodInfo SocketConnectionFactoryCreateConnectionMethodInfo a signature where overloadedMethod = socketConnectionFactoryCreateConnection #endif -- method Socket::get_available_bytes -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TInt32) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_available_bytes" g_socket_get_available_bytes :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Int32 -- | Get the amount of data pending in the OS input buffer, without blocking. -- -- If /@socket@/ is a UDP or SCTP socket, this will return the size of -- just the next packet, even if additional packets are buffered after -- that one. -- -- Note that on Windows, this function is rather inefficient in the -- UDP case, and so if you know any plausible upper bound on the size -- of the incoming packet, it is better to just do a -- 'GI.Gio.Objects.Socket.socketReceive' with a buffer of that size, rather than calling -- 'GI.Gio.Objects.Socket.socketGetAvailableBytes' first and then doing a receive of -- exactly the right size. -- -- /Since: 2.32/ socketGetAvailableBytes :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m Int32 -- ^ __Returns:__ the number of bytes that can be read from the socket -- without blocking or truncating, or -1 on error. socketGetAvailableBytes socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_available_bytes socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetAvailableBytesMethodInfo instance (signature ~ (m Int32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetAvailableBytesMethodInfo a signature where overloadedMethod = socketGetAvailableBytes #endif -- method Socket::get_blocking -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_blocking" g_socket_get_blocking :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Gets the blocking mode of the socket. For details on blocking I\/O, -- see 'GI.Gio.Objects.Socket.socketSetBlocking'. -- -- /Since: 2.22/ socketGetBlocking :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Bool -- ^ __Returns:__ 'P.True' if blocking I\/O is used, 'P.False' otherwise. socketGetBlocking socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_blocking socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetBlockingMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketGetBlockingMethodInfo a signature where overloadedMethod = socketGetBlocking #endif -- method Socket::get_broadcast -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_broadcast" g_socket_get_broadcast :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Gets the broadcast setting on /@socket@/; if 'P.True', -- it is possible to send packets to broadcast -- addresses. -- -- /Since: 2.32/ socketGetBroadcast :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Bool -- ^ __Returns:__ the broadcast setting on /@socket@/ socketGetBroadcast socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_broadcast socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetBroadcastMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketGetBroadcastMethodInfo a signature where overloadedMethod = socketGetBroadcast #endif -- method Socket::get_credentials -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "Gio" , name = "Credentials" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_get_credentials" g_socket_get_credentials :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO (Ptr Gio.Credentials.Credentials) -- | Returns the credentials of the foreign process connected to this -- socket, if any (e.g. it is only supported for 'GI.Gio.Enums.SocketFamilyUnix' -- sockets). -- -- If this operation isn\'t supported on the OS, the method fails with -- the 'GI.Gio.Enums.IOErrorEnumNotSupported' error. On Linux this is implemented -- by reading the @/SO_PEERCRED/@ option on the underlying socket. -- -- This method can be expected to be available on the following platforms: -- -- * Linux since GLib 2.26 -- * OpenBSD since GLib 2.30 -- * Solaris, Illumos and OpenSolaris since GLib 2.40 -- * NetBSD since GLib 2.42 -- -- -- Other ways to obtain credentials from a foreign peer includes the -- t'GI.Gio.Objects.UnixCredentialsMessage.UnixCredentialsMessage' type and -- 'GI.Gio.Objects.UnixConnection.unixConnectionSendCredentials' \/ -- 'GI.Gio.Objects.UnixConnection.unixConnectionReceiveCredentials' functions. -- -- /Since: 2.26/ socketGetCredentials :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.Credentials.Credentials -- ^ __Returns:__ 'P.Nothing' if /@error@/ is set, otherwise a t'GI.Gio.Objects.Credentials.Credentials' object -- that must be freed with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketGetCredentials socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do result <- propagateGError $ g_socket_get_credentials socket' checkUnexpectedReturnNULL "socketGetCredentials" result result' <- (wrapObject Gio.Credentials.Credentials) result touchManagedPtr socket return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketGetCredentialsMethodInfo instance (signature ~ (m Gio.Credentials.Credentials), MonadIO m, IsSocket a) => O.MethodInfo SocketGetCredentialsMethodInfo a signature where overloadedMethod = socketGetCredentials #endif -- method Socket::get_family -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , 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_get_family" g_socket_get_family :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CUInt -- | Gets the socket family of the socket. -- -- /Since: 2.22/ socketGetFamily :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.Enums.SocketFamily -- ^ __Returns:__ a t'GI.Gio.Enums.SocketFamily' socketGetFamily socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_family socket' let result' = (toEnum . fromIntegral) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetFamilyMethodInfo instance (signature ~ (m Gio.Enums.SocketFamily), MonadIO m, IsSocket a) => O.MethodInfo SocketGetFamilyMethodInfo a signature where overloadedMethod = socketGetFamily #endif -- method Socket::get_fd -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TInt) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_fd" g_socket_get_fd :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Int32 -- | Returns the underlying OS socket object. On unix this -- is a socket file descriptor, and on Windows this is -- a Winsock2 SOCKET handle. This may be useful for -- doing platform specific or otherwise unusual operations -- on the socket. -- -- /Since: 2.22/ socketGetFd :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Int32 -- ^ __Returns:__ the file descriptor of the socket. socketGetFd socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_fd socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetFdMethodInfo instance (signature ~ (m Int32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetFdMethodInfo a signature where overloadedMethod = socketGetFd #endif -- method Socket::get_keepalive -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_keepalive" g_socket_get_keepalive :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Gets the keepalive mode of the socket. For details on this, -- see 'GI.Gio.Objects.Socket.socketSetKeepalive'. -- -- /Since: 2.22/ socketGetKeepalive :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Bool -- ^ __Returns:__ 'P.True' if keepalive is active, 'P.False' otherwise. socketGetKeepalive socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_keepalive socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetKeepaliveMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketGetKeepaliveMethodInfo a signature where overloadedMethod = socketGetKeepalive #endif -- method Socket::get_listen_backlog -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TInt) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_listen_backlog" g_socket_get_listen_backlog :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Int32 -- | Gets the listen backlog setting of the socket. For details on this, -- see 'GI.Gio.Objects.Socket.socketSetListenBacklog'. -- -- /Since: 2.22/ socketGetListenBacklog :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Int32 -- ^ __Returns:__ the maximum number of pending connections. socketGetListenBacklog socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_listen_backlog socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetListenBacklogMethodInfo instance (signature ~ (m Int32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetListenBacklogMethodInfo a signature where overloadedMethod = socketGetListenBacklog #endif -- method Socket::get_local_address -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "Gio" , name = "SocketAddress" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_get_local_address" g_socket_get_local_address :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO (Ptr Gio.SocketAddress.SocketAddress) -- | Try to get the local address of a bound socket. This is only -- useful if the socket has been bound to a local address, -- either explicitly or implicitly when connecting. -- -- /Since: 2.22/ socketGetLocalAddress :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.SocketAddress.SocketAddress -- ^ __Returns:__ a t'GI.Gio.Objects.SocketAddress.SocketAddress' or 'P.Nothing' on error. -- Free the returned object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketGetLocalAddress socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do result <- propagateGError $ g_socket_get_local_address socket' checkUnexpectedReturnNULL "socketGetLocalAddress" result result' <- (wrapObject Gio.SocketAddress.SocketAddress) result touchManagedPtr socket return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketGetLocalAddressMethodInfo instance (signature ~ (m Gio.SocketAddress.SocketAddress), MonadIO m, IsSocket a) => O.MethodInfo SocketGetLocalAddressMethodInfo a signature where overloadedMethod = socketGetLocalAddress #endif -- method Socket::get_multicast_loopback -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_multicast_loopback" g_socket_get_multicast_loopback :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Gets the multicast loopback setting on /@socket@/; if 'P.True' (the -- default), outgoing multicast packets will be looped back to -- multicast listeners on the same host. -- -- /Since: 2.32/ socketGetMulticastLoopback :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Bool -- ^ __Returns:__ the multicast loopback setting on /@socket@/ socketGetMulticastLoopback socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_multicast_loopback socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetMulticastLoopbackMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketGetMulticastLoopbackMethodInfo a signature where overloadedMethod = socketGetMulticastLoopback #endif -- method Socket::get_multicast_ttl -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TUInt) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_multicast_ttl" g_socket_get_multicast_ttl :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Word32 -- | Gets the multicast time-to-live setting on /@socket@/; see -- 'GI.Gio.Objects.Socket.socketSetMulticastTtl' for more details. -- -- /Since: 2.32/ socketGetMulticastTtl :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Word32 -- ^ __Returns:__ the multicast time-to-live setting on /@socket@/ socketGetMulticastTtl socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_multicast_ttl socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetMulticastTtlMethodInfo instance (signature ~ (m Word32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetMulticastTtlMethodInfo a signature where overloadedMethod = socketGetMulticastTtl #endif -- method Socket::get_option -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "level" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the \"API level\" of the option (eg, `SOL_SOCKET`)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "optname" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the \"name\" of the option (eg, `SO_BROADCAST`)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "value" -- , argType = TBasicType TInt -- , direction = DirectionOut -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "return location for the option value" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : True -- Skip return : False foreign import ccall "g_socket_get_option" g_socket_get_option :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Int32 -> -- level : TBasicType TInt Int32 -> -- optname : TBasicType TInt Ptr Int32 -> -- value : TBasicType TInt Ptr (Ptr GError) -> -- error IO CInt -- | Gets the value of an integer-valued option on /@socket@/, as with -- @/getsockopt()/@. (If you need to fetch a non-integer-valued option, -- you will need to call @/getsockopt()/@ directly.) -- -- The [\<gio\/gnetworking.h>][gio-gnetworking.h] -- header pulls in system headers that will define most of the -- standard\/portable socket options. For unusual socket protocols or -- platform-dependent options, you may need to include additional -- headers. -- -- Note that even for socket options that are a single byte in size, -- /@value@/ is still a pointer to a @/gint/@ variable, not a @/guchar/@; -- 'GI.Gio.Objects.Socket.socketGetOption' will handle the conversion internally. -- -- /Since: 2.36/ socketGetOption :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Int32 -- ^ /@level@/: the \"API level\" of the option (eg, @SOL_SOCKET@) -> Int32 -- ^ /@optname@/: the \"name\" of the option (eg, @SO_BROADCAST@) -> m (Int32) -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketGetOption socket level optname = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket value <- allocMem :: IO (Ptr Int32) onException (do _ <- propagateGError $ g_socket_get_option socket' level optname value value' <- peek value touchManagedPtr socket freeMem value return value' ) (do freeMem value ) #if defined(ENABLE_OVERLOADING) data SocketGetOptionMethodInfo instance (signature ~ (Int32 -> Int32 -> m (Int32)), MonadIO m, IsSocket a) => O.MethodInfo SocketGetOptionMethodInfo a signature where overloadedMethod = socketGetOption #endif -- method Socket::get_protocol -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "Gio" , name = "SocketProtocol" }) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_protocol" g_socket_get_protocol :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Gets the socket protocol id the socket was created with. -- In case the protocol is unknown, -1 is returned. -- -- /Since: 2.22/ socketGetProtocol :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.Enums.SocketProtocol -- ^ __Returns:__ a protocol id, or -1 if unknown socketGetProtocol socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_protocol socket' let result' = (toEnum . fromIntegral) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetProtocolMethodInfo instance (signature ~ (m Gio.Enums.SocketProtocol), MonadIO m, IsSocket a) => O.MethodInfo SocketGetProtocolMethodInfo a signature where overloadedMethod = socketGetProtocol #endif -- method Socket::get_remote_address -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just -- (TInterface Name { namespace = "Gio" , name = "SocketAddress" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_get_remote_address" g_socket_get_remote_address :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO (Ptr Gio.SocketAddress.SocketAddress) -- | Try to get the remote address of a connected socket. This is only -- useful for connection oriented sockets that have been connected. -- -- /Since: 2.22/ socketGetRemoteAddress :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.SocketAddress.SocketAddress -- ^ __Returns:__ a t'GI.Gio.Objects.SocketAddress.SocketAddress' or 'P.Nothing' on error. -- Free the returned object with 'GI.GObject.Objects.Object.objectUnref'. /(Can throw 'Data.GI.Base.GError.GError')/ socketGetRemoteAddress socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do result <- propagateGError $ g_socket_get_remote_address socket' checkUnexpectedReturnNULL "socketGetRemoteAddress" result result' <- (wrapObject Gio.SocketAddress.SocketAddress) result touchManagedPtr socket return result' ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketGetRemoteAddressMethodInfo instance (signature ~ (m Gio.SocketAddress.SocketAddress), MonadIO m, IsSocket a) => O.MethodInfo SocketGetRemoteAddressMethodInfo a signature where overloadedMethod = socketGetRemoteAddress #endif -- method Socket::get_socket_type -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TInterface Name { namespace = "Gio" , name = "SocketType" }) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_socket_type" g_socket_get_socket_type :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CUInt -- | Gets the socket type of the socket. -- -- /Since: 2.22/ socketGetSocketType :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Gio.Enums.SocketType -- ^ __Returns:__ a t'GI.Gio.Enums.SocketType' socketGetSocketType socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_socket_type socket' let result' = (toEnum . fromIntegral) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketGetSocketTypeMethodInfo instance (signature ~ (m Gio.Enums.SocketType), MonadIO m, IsSocket a) => O.MethodInfo SocketGetSocketTypeMethodInfo a signature where overloadedMethod = socketGetSocketType #endif -- method Socket::get_timeout -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TUInt) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_timeout" g_socket_get_timeout :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Word32 -- | Gets the timeout setting of the socket. For details on this, see -- 'GI.Gio.Objects.Socket.socketSetTimeout'. -- -- /Since: 2.26/ socketGetTimeout :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Word32 -- ^ __Returns:__ the timeout in seconds socketGetTimeout socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_timeout socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetTimeoutMethodInfo instance (signature ~ (m Word32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetTimeoutMethodInfo a signature where overloadedMethod = socketGetTimeout #endif -- method Socket::get_ttl -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TUInt) -- throws : False -- Skip return : False foreign import ccall "g_socket_get_ttl" g_socket_get_ttl :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO Word32 -- | Gets the unicast time-to-live setting on /@socket@/; see -- 'GI.Gio.Objects.Socket.socketSetTtl' for more details. -- -- /Since: 2.32/ socketGetTtl :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Word32 -- ^ __Returns:__ the time-to-live setting on /@socket@/ socketGetTtl socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_get_ttl socket' touchManagedPtr socket return result #if defined(ENABLE_OVERLOADING) data SocketGetTtlMethodInfo instance (signature ~ (m Word32), MonadIO m, IsSocket a) => O.MethodInfo SocketGetTtlMethodInfo a signature where overloadedMethod = socketGetTtl #endif -- method Socket::is_closed -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_is_closed" g_socket_is_closed :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Checks whether a socket is closed. -- -- /Since: 2.22/ socketIsClosed :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m Bool -- ^ __Returns:__ 'P.True' if socket is closed, 'P.False' otherwise socketIsClosed socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_is_closed socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketIsClosedMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketIsClosedMethodInfo a signature where overloadedMethod = socketIsClosed #endif -- method Socket::is_connected -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_is_connected" g_socket_is_connected :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Check whether the socket is connected. This is only useful for -- connection-oriented sockets. -- -- If using 'GI.Gio.Objects.Socket.socketShutdown', this function will return 'P.True' until the -- socket has been shut down for reading and writing. If you do a non-blocking -- connect, this function will not return 'P.True' until after you call -- 'GI.Gio.Objects.Socket.socketCheckConnectResult'. -- -- /Since: 2.22/ socketIsConnected :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m Bool -- ^ __Returns:__ 'P.True' if socket is connected, 'P.False' otherwise. socketIsConnected socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_is_connected socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketIsConnectedMethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketIsConnectedMethodInfo a signature where overloadedMethod = socketIsConnected #endif -- method Socket::join_multicast_group -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "group" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GInetAddress specifying the group address to join." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "source_specific" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "%TRUE if source-specific multicast should be used" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "iface" -- , argType = TBasicType TUTF8 -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "Name of the interface to use, or %NULL" -- , 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_join_multicast_group" g_socket_join_multicast_group :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.InetAddress.InetAddress -> -- group : TInterface (Name {namespace = "Gio", name = "InetAddress"}) CInt -> -- source_specific : TBasicType TBoolean CString -> -- iface : TBasicType TUTF8 Ptr (Ptr GError) -> -- error IO CInt -- | Registers /@socket@/ to receive multicast messages sent to /@group@/. -- /@socket@/ must be a 'GI.Gio.Enums.SocketTypeDatagram' socket, and must have -- been bound to an appropriate interface and port with -- 'GI.Gio.Objects.Socket.socketBind'. -- -- If /@iface@/ is 'P.Nothing', the system will automatically pick an interface -- to bind to based on /@group@/. -- -- If /@sourceSpecific@/ is 'P.True', source-specific multicast as defined -- in RFC 4604 is used. Note that on older platforms this may fail -- with a 'GI.Gio.Enums.IOErrorEnumNotSupported' error. -- -- To bind to a given source-specific multicast address, use -- 'GI.Gio.Objects.Socket.socketJoinMulticastGroupSsm' instead. -- -- /Since: 2.32/ socketJoinMulticastGroup :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@group@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the group address to join. -> Bool -- ^ /@sourceSpecific@/: 'P.True' if source-specific multicast should be used -> Maybe (T.Text) -- ^ /@iface@/: Name of the interface to use, or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketJoinMulticastGroup socket group sourceSpecific iface = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket group' <- unsafeManagedPtrCastPtr group let sourceSpecific' = (fromIntegral . fromEnum) sourceSpecific maybeIface <- case iface of Nothing -> return nullPtr Just jIface -> do jIface' <- textToCString jIface return jIface' onException (do _ <- propagateGError $ g_socket_join_multicast_group socket' group' sourceSpecific' maybeIface touchManagedPtr socket touchManagedPtr group freeMem maybeIface return () ) (do freeMem maybeIface ) #if defined(ENABLE_OVERLOADING) data SocketJoinMulticastGroupMethodInfo instance (signature ~ (b -> Bool -> Maybe (T.Text) -> m ()), MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b) => O.MethodInfo SocketJoinMulticastGroupMethodInfo a signature where overloadedMethod = socketJoinMulticastGroup #endif -- method Socket::join_multicast_group_ssm -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "group" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GInetAddress specifying the group address to join." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "source_specific" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a #GInetAddress specifying the\nsource-specific multicast address or %NULL to ignore." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "iface" -- , argType = TBasicType TUTF8 -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "Name of the interface to use, or %NULL" -- , 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_join_multicast_group_ssm" g_socket_join_multicast_group_ssm :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.InetAddress.InetAddress -> -- group : TInterface (Name {namespace = "Gio", name = "InetAddress"}) Ptr Gio.InetAddress.InetAddress -> -- source_specific : TInterface (Name {namespace = "Gio", name = "InetAddress"}) CString -> -- iface : TBasicType TUTF8 Ptr (Ptr GError) -> -- error IO CInt -- | Registers /@socket@/ to receive multicast messages sent to /@group@/. -- /@socket@/ must be a 'GI.Gio.Enums.SocketTypeDatagram' socket, and must have -- been bound to an appropriate interface and port with -- 'GI.Gio.Objects.Socket.socketBind'. -- -- If /@iface@/ is 'P.Nothing', the system will automatically pick an interface -- to bind to based on /@group@/. -- -- If /@sourceSpecific@/ is not 'P.Nothing', use source-specific multicast as -- defined in RFC 4604. Note that on older platforms this may fail -- with a 'GI.Gio.Enums.IOErrorEnumNotSupported' error. -- -- Note that this function can be called multiple times for the same -- /@group@/ with different /@sourceSpecific@/ in order to receive multicast -- packets from more than one source. -- -- /Since: 2.56/ socketJoinMulticastGroupSsm :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b, Gio.InetAddress.IsInetAddress c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@group@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the group address to join. -> Maybe (c) -- ^ /@sourceSpecific@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the -- source-specific multicast address or 'P.Nothing' to ignore. -> Maybe (T.Text) -- ^ /@iface@/: Name of the interface to use, or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketJoinMulticastGroupSsm socket group sourceSpecific iface = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket group' <- unsafeManagedPtrCastPtr group maybeSourceSpecific <- case sourceSpecific of Nothing -> return nullPtr Just jSourceSpecific -> do jSourceSpecific' <- unsafeManagedPtrCastPtr jSourceSpecific return jSourceSpecific' maybeIface <- case iface of Nothing -> return nullPtr Just jIface -> do jIface' <- textToCString jIface return jIface' onException (do _ <- propagateGError $ g_socket_join_multicast_group_ssm socket' group' maybeSourceSpecific maybeIface touchManagedPtr socket touchManagedPtr group whenJust sourceSpecific touchManagedPtr freeMem maybeIface return () ) (do freeMem maybeIface ) #if defined(ENABLE_OVERLOADING) data SocketJoinMulticastGroupSsmMethodInfo instance (signature ~ (b -> Maybe (c) -> Maybe (T.Text) -> m ()), MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b, Gio.InetAddress.IsInetAddress c) => O.MethodInfo SocketJoinMulticastGroupSsmMethodInfo a signature where overloadedMethod = socketJoinMulticastGroupSsm #endif -- method Socket::leave_multicast_group -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "group" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GInetAddress specifying the group address to leave." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "source_specific" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "%TRUE if source-specific multicast was used" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "iface" -- , argType = TBasicType TUTF8 -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "Interface used" , 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_leave_multicast_group" g_socket_leave_multicast_group :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.InetAddress.InetAddress -> -- group : TInterface (Name {namespace = "Gio", name = "InetAddress"}) CInt -> -- source_specific : TBasicType TBoolean CString -> -- iface : TBasicType TUTF8 Ptr (Ptr GError) -> -- error IO CInt -- | Removes /@socket@/ from the multicast group defined by /@group@/, /@iface@/, -- and /@sourceSpecific@/ (which must all have the same values they had -- when you joined the group). -- -- /@socket@/ remains bound to its address and port, and can still receive -- unicast messages after calling this. -- -- To unbind to a given source-specific multicast address, use -- 'GI.Gio.Objects.Socket.socketLeaveMulticastGroupSsm' instead. -- -- /Since: 2.32/ socketLeaveMulticastGroup :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@group@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the group address to leave. -> Bool -- ^ /@sourceSpecific@/: 'P.True' if source-specific multicast was used -> Maybe (T.Text) -- ^ /@iface@/: Interface used -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketLeaveMulticastGroup socket group sourceSpecific iface = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket group' <- unsafeManagedPtrCastPtr group let sourceSpecific' = (fromIntegral . fromEnum) sourceSpecific maybeIface <- case iface of Nothing -> return nullPtr Just jIface -> do jIface' <- textToCString jIface return jIface' onException (do _ <- propagateGError $ g_socket_leave_multicast_group socket' group' sourceSpecific' maybeIface touchManagedPtr socket touchManagedPtr group freeMem maybeIface return () ) (do freeMem maybeIface ) #if defined(ENABLE_OVERLOADING) data SocketLeaveMulticastGroupMethodInfo instance (signature ~ (b -> Bool -> Maybe (T.Text) -> m ()), MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b) => O.MethodInfo SocketLeaveMulticastGroupMethodInfo a signature where overloadedMethod = socketLeaveMulticastGroup #endif -- method Socket::leave_multicast_group_ssm -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "group" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a #GInetAddress specifying the group address to leave." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "source_specific" -- , argType = -- TInterface Name { namespace = "Gio" , name = "InetAddress" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a #GInetAddress specifying the\nsource-specific multicast address or %NULL to ignore." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "iface" -- , argType = TBasicType TUTF8 -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "Name of the interface to use, or %NULL" -- , 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_leave_multicast_group_ssm" g_socket_leave_multicast_group_ssm :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.InetAddress.InetAddress -> -- group : TInterface (Name {namespace = "Gio", name = "InetAddress"}) Ptr Gio.InetAddress.InetAddress -> -- source_specific : TInterface (Name {namespace = "Gio", name = "InetAddress"}) CString -> -- iface : TBasicType TUTF8 Ptr (Ptr GError) -> -- error IO CInt -- | Removes /@socket@/ from the multicast group defined by /@group@/, /@iface@/, -- and /@sourceSpecific@/ (which must all have the same values they had -- when you joined the group). -- -- /@socket@/ remains bound to its address and port, and can still receive -- unicast messages after calling this. -- -- /Since: 2.56/ socketLeaveMulticastGroupSsm :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b, Gio.InetAddress.IsInetAddress c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> b -- ^ /@group@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the group address to leave. -> Maybe (c) -- ^ /@sourceSpecific@/: a t'GI.Gio.Objects.InetAddress.InetAddress' specifying the -- source-specific multicast address or 'P.Nothing' to ignore. -> Maybe (T.Text) -- ^ /@iface@/: Name of the interface to use, or 'P.Nothing' -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketLeaveMulticastGroupSsm socket group sourceSpecific iface = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket group' <- unsafeManagedPtrCastPtr group maybeSourceSpecific <- case sourceSpecific of Nothing -> return nullPtr Just jSourceSpecific -> do jSourceSpecific' <- unsafeManagedPtrCastPtr jSourceSpecific return jSourceSpecific' maybeIface <- case iface of Nothing -> return nullPtr Just jIface -> do jIface' <- textToCString jIface return jIface' onException (do _ <- propagateGError $ g_socket_leave_multicast_group_ssm socket' group' maybeSourceSpecific maybeIface touchManagedPtr socket touchManagedPtr group whenJust sourceSpecific touchManagedPtr freeMem maybeIface return () ) (do freeMem maybeIface ) #if defined(ENABLE_OVERLOADING) data SocketLeaveMulticastGroupSsmMethodInfo instance (signature ~ (b -> Maybe (c) -> Maybe (T.Text) -> m ()), MonadIO m, IsSocket a, Gio.InetAddress.IsInetAddress b, Gio.InetAddress.IsInetAddress c) => O.MethodInfo SocketLeaveMulticastGroupSsmMethodInfo a signature where overloadedMethod = socketLeaveMulticastGroupSsm #endif -- method Socket::listen -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , 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_listen" g_socket_listen :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr GError) -> -- error IO CInt -- | Marks the socket as a server socket, i.e. a socket that is used -- to accept incoming requests using 'GI.Gio.Objects.Socket.socketAccept'. -- -- Before calling this the socket must be bound to a local address using -- 'GI.Gio.Objects.Socket.socketBind'. -- -- To set the maximum amount of outstanding clients, use -- 'GI.Gio.Objects.Socket.socketSetListenBacklog'. -- -- /Since: 2.22/ socketListen :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketListen socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do _ <- propagateGError $ g_socket_listen socket' touchManagedPtr socket return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketListenMethodInfo instance (signature ~ (m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketListenMethodInfo a signature where overloadedMethod = socketListen #endif -- method Socket::receive -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 2 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a buffer to\n read data into (which should be at least @size bytes long)." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_receive" g_socket_receive :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Word8 -> -- buffer : TCArray False (-1) 2 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Receive data (up to /@size@/ bytes) from a socket. This is mainly used by -- connection-oriented sockets; it is identical to 'GI.Gio.Objects.Socket.socketReceiveFrom' -- with /@address@/ set to 'P.Nothing'. -- -- For 'GI.Gio.Enums.SocketTypeDatagram' and 'GI.Gio.Enums.SocketTypeSeqpacket' sockets, -- 'GI.Gio.Objects.Socket.socketReceive' will always read either 0 or 1 complete messages from -- the socket. If the received message is too large to fit in /@buffer@/, then -- the data beyond /@size@/ bytes will be discarded, without any explicit -- indication that this has occurred. -- -- For 'GI.Gio.Enums.SocketTypeStream' sockets, 'GI.Gio.Objects.Socket.socketReceive' can return any -- number of bytes, up to /@size@/. If more than /@size@/ bytes have been -- received, the additional data will be returned in future calls to -- 'GI.Gio.Objects.Socket.socketReceive'. -- -- If the socket is in blocking mode the call will block until there -- is some data to receive, the connection is closed, or there is an -- error. If there is no data available and the socket is in -- non-blocking mode, a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error will be -- returned. To be notified when data is available, wait for the -- 'GI.GLib.Flags.IOConditionIn' condition. -- -- On error -1 is returned and /@error@/ is set accordingly. -- -- /Since: 2.22/ socketReceive :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> ByteString -- ^ /@buffer@/: a buffer to -- read data into (which should be at least /@size@/ bytes long). -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes read, or 0 if the connection was closed by -- the peer, or -1 on error /(Can throw 'Data.GI.Base.GError.GError')/ socketReceive socket buffer cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket buffer' <- packByteString buffer maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_receive socket' buffer' size maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr freeMem buffer' return result ) (do freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketReceiveMethodInfo instance (signature ~ (ByteString -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketReceiveMethodInfo a signature where overloadedMethod = socketReceive #endif -- method Socket::receive_from -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionOut -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "a pointer to a #GSocketAddress\n pointer, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 3 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a buffer to\n read data into (which should be at least @size bytes long)." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_receive_from" g_socket_receive_from :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr Gio.SocketAddress.SocketAddress) -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Word8 -> -- buffer : TCArray False (-1) 3 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Receive data (up to /@size@/ bytes) from a socket. -- -- If /@address@/ is non-'P.Nothing' then /@address@/ will be set equal to the -- source address of the received packet. -- /@address@/ is owned by the caller. -- -- See 'GI.Gio.Objects.Socket.socketReceive' for additional information. -- -- /Since: 2.22/ socketReceiveFrom :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> ByteString -- ^ /@buffer@/: a buffer to -- read data into (which should be at least /@size@/ bytes long). -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m ((Int32, Gio.SocketAddress.SocketAddress)) -- ^ __Returns:__ Number of bytes read, or 0 if the connection was closed by -- the peer, or -1 on error /(Can throw 'Data.GI.Base.GError.GError')/ socketReceiveFrom socket buffer cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket address <- allocMem :: IO (Ptr (Ptr Gio.SocketAddress.SocketAddress)) buffer' <- packByteString buffer maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_receive_from socket' address buffer' size maybeCancellable address' <- peek address address'' <- (wrapObject Gio.SocketAddress.SocketAddress) address' touchManagedPtr socket whenJust cancellable touchManagedPtr freeMem address freeMem buffer' return (result, address'') ) (do freeMem address freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketReceiveFromMethodInfo instance (signature ~ (ByteString -> Maybe (b) -> m ((Int32, Gio.SocketAddress.SocketAddress))), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketReceiveFromMethodInfo a signature where overloadedMethod = socketReceiveFrom #endif -- method Socket::receive_message -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionOut -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just "a pointer to a #GSocketAddress\n pointer, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "vectors" -- , argType = -- TCArray -- False -- (-1) -- 3 -- (TInterface Name { namespace = "Gio" , name = "InputVector" }) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an array of #GInputVector structs" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "messages" -- , argType = -- TCArray -- False -- (-1) -- 5 -- (TInterface -- Name { namespace = "Gio" , name = "SocketControlMessage" }) -- , direction = DirectionOut -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer\n which may be filled with an array of #GSocketControlMessages, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionOut -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer which will be filled with the number of\n elements in @messages, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionInout -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer to an int containing #GSocketMsgFlags flags,\n which may additionally contain\n [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionOut -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer which will be filled with the number of\n elements in @messages, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_receive_message" g_socket_receive_message :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr (Ptr Gio.SocketAddress.SocketAddress) -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Gio.InputVector.InputVector -> -- vectors : TCArray False (-1) 3 (TInterface (Name {namespace = "Gio", name = "InputVector"})) Int32 -> -- num_vectors : TBasicType TInt Ptr (Ptr (Ptr Gio.SocketControlMessage.SocketControlMessage)) -> -- messages : TCArray False (-1) 5 (TInterface (Name {namespace = "Gio", name = "SocketControlMessage"})) Ptr Int32 -> -- num_messages : TBasicType TInt Ptr Int32 -> -- flags : TBasicType TInt Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Receive data from a socket. For receiving multiple messages, see -- 'GI.Gio.Objects.Socket.socketReceiveMessages'; for easier use, see -- 'GI.Gio.Objects.Socket.socketReceive' and 'GI.Gio.Objects.Socket.socketReceiveFrom'. -- -- If /@address@/ is non-'P.Nothing' then /@address@/ will be set equal to the -- source address of the received packet. -- /@address@/ is owned by the caller. -- -- /@vector@/ must point to an array of t'GI.Gio.Structs.InputVector.InputVector' structs and -- /@numVectors@/ must be the length of this array. These structs -- describe the buffers that received data will be scattered into. -- If /@numVectors@/ is -1, then /@vectors@/ is assumed to be terminated -- by a t'GI.Gio.Structs.InputVector.InputVector' with a 'P.Nothing' buffer pointer. -- -- As a special case, if /@numVectors@/ is 0 (in which case, /@vectors@/ -- may of course be 'P.Nothing'), then a single byte is received and -- discarded. This is to facilitate the common practice of sending a -- single \'\\0\' byte for the purposes of transferring ancillary data. -- -- /@messages@/, if non-'P.Nothing', will be set to point to a newly-allocated -- array of t'GI.Gio.Objects.SocketControlMessage.SocketControlMessage' instances or 'P.Nothing' if no such -- messages was received. These correspond to the control messages -- received from the kernel, one t'GI.Gio.Objects.SocketControlMessage.SocketControlMessage' per message -- from the kernel. This array is 'P.Nothing'-terminated and must be freed -- by the caller using 'GI.GLib.Functions.free' after calling 'GI.GObject.Objects.Object.objectUnref' on each -- element. If /@messages@/ is 'P.Nothing', any control messages received will -- be discarded. -- -- /@numMessages@/, if non-'P.Nothing', will be set to the number of control -- messages received. -- -- If both /@messages@/ and /@numMessages@/ are non-'P.Nothing', then -- /@numMessages@/ gives the number of t'GI.Gio.Objects.SocketControlMessage.SocketControlMessage' instances -- in /@messages@/ (ie: not including the 'P.Nothing' terminator). -- -- /@flags@/ is an in\/out parameter. 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 -- (and 'GI.Gio.Objects.Socket.socketReceiveMessage' may pass system-specific flags out). -- Flags passed in to the parameter affect the receive operation; flags returned -- out of it are relevant to the specific returned message. -- -- As with 'GI.Gio.Objects.Socket.socketReceive', data may be discarded if /@socket@/ is -- 'GI.Gio.Enums.SocketTypeDatagram' or 'GI.Gio.Enums.SocketTypeSeqpacket' and you do not -- provide enough buffer space to read a complete message. You can pass -- 'GI.Gio.Flags.SocketMsgFlagsPeek' in /@flags@/ to peek at the current message without -- removing it from the receive queue, but there is no portable way to find -- out the length of the message other than by reading it into a -- sufficiently-large buffer. -- -- If the socket is in blocking mode the call will block until there -- is some data to receive, the connection is closed, or there is an -- error. If there is no data available and the socket is in -- non-blocking mode, a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error will be -- returned. To be notified when data is available, wait for the -- 'GI.GLib.Flags.IOConditionIn' condition. -- -- On error -1 is returned and /@error@/ is set accordingly. -- -- /Since: 2.22/ socketReceiveMessage :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [Gio.InputVector.InputVector] -- ^ /@vectors@/: an array of t'GI.Gio.Structs.InputVector.InputVector' structs -> Int32 -- ^ /@flags@/: a pointer to an int containing t'GI.Gio.Flags.SocketMsgFlags' flags, -- which may additionally contain -- <http://man7.org/linux/man-pages/man2/recv.2.html other platform specific flags> -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m ((Int32, Maybe Gio.SocketAddress.SocketAddress, Maybe [Gio.SocketControlMessage.SocketControlMessage], Int32)) -- ^ __Returns:__ Number of bytes read, or 0 if the connection was closed by -- the peer, or -1 on error /(Can throw 'Data.GI.Base.GError.GError')/ socketReceiveMessage socket vectors flags cancellable = liftIO $ do let numVectors = fromIntegral $ length vectors socket' <- unsafeManagedPtrCastPtr socket address <- allocMem :: IO (Ptr (Ptr Gio.SocketAddress.SocketAddress)) vectors' <- mapM unsafeManagedPtrGetPtr vectors vectors'' <- packBlockArray 8 vectors' messages <- allocMem :: IO (Ptr (Ptr (Ptr Gio.SocketControlMessage.SocketControlMessage))) numMessages <- allocMem :: IO (Ptr Int32) flags' <- allocMem :: IO (Ptr Int32) poke flags' flags maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_receive_message socket' address vectors'' numVectors messages numMessages flags' maybeCancellable numMessages' <- peek numMessages address' <- peek address maybeAddress' <- convertIfNonNull address' $ \address'' -> do address''' <- (wrapObject Gio.SocketAddress.SocketAddress) address'' return address''' messages' <- peek messages maybeMessages' <- convertIfNonNull messages' $ \messages'' -> do messages''' <- (unpackPtrArrayWithLength numMessages') messages'' messages'''' <- mapM (wrapObject Gio.SocketControlMessage.SocketControlMessage) messages''' freeMem messages'' return messages'''' flags'' <- peek flags' touchManagedPtr socket mapM_ touchManagedPtr vectors whenJust cancellable touchManagedPtr freeMem address freeMem vectors'' freeMem messages freeMem numMessages freeMem flags' return (result, maybeAddress', maybeMessages', flags'') ) (do freeMem address freeMem vectors'' freeMem messages freeMem numMessages freeMem flags' ) #if defined(ENABLE_OVERLOADING) data SocketReceiveMessageMethodInfo instance (signature ~ ([Gio.InputVector.InputVector] -> Int32 -> Maybe (b) -> m ((Int32, Maybe Gio.SocketAddress.SocketAddress, Maybe [Gio.SocketControlMessage.SocketControlMessage], Int32))), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketReceiveMessageMethodInfo a signature where overloadedMethod = socketReceiveMessage #endif -- method Socket::receive_messages -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , 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 -- , 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,\n which may additionally contain\n [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt) -- throws : True -- Skip return : False foreign import ccall "g_socket_receive_messages" g_socket_receive_messages :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.InputMessage.InputMessage -> -- messages : TCArray False (-1) 2 (TInterface (Name {namespace = "Gio", name = "InputMessage"})) Word32 -> -- num_messages : TBasicType TUInt Int32 -> -- flags : TBasicType TInt Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Receive multiple data messages from /@socket@/ in one go. This is the most -- complicated and fully-featured version of this call. For easier use, see -- 'GI.Gio.Objects.Socket.socketReceive', 'GI.Gio.Objects.Socket.socketReceiveFrom', and 'GI.Gio.Objects.Socket.socketReceiveMessage'. -- -- /@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. Using -- multiple @/GInputVectors/@ is more memory-efficient than manually copying data -- out of a single buffer to multiple sources, and more system-call-efficient -- than making multiple calls to 'GI.Gio.Objects.Socket.socketReceive', such as in scenarios where -- a lot of data packets need to be received (e.g. high-bandwidth video -- streaming over RTP\/UDP). -- -- /@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 t'GI.Gio.Objects.Socket.Socket':@/blocking/@ is 'P.True' the call will block until /@numMessages@/ have -- been received, or the end of the stream is reached. -- -- If t'GI.Gio.Objects.Socket.Socket':@/blocking/@ is 'P.False' 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. -- -- In blocking mode, if t'GI.Gio.Objects.Socket.Socket':@/timeout/@ is positive and is reached before any -- messages are received, 'GI.Gio.Enums.IOErrorEnumTimedOut' is returned, otherwise up to -- /@numMessages@/ are returned. (Note: This is effectively the -- behaviour of @MSG_WAITFORONE@ with @/recvmmsg()/@.) -- -- To be notified when messages are available, wait for the -- 'GI.GLib.Flags.IOConditionIn' condition. Note though that you may still receive -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' from 'GI.Gio.Objects.Socket.socketReceiveMessages' even if you were -- previously notified of a 'GI.GLib.Flags.IOConditionIn' condition. -- -- If the remote peer closes the connection, any messages queued in the -- operating system will be returned, and subsequent calls to -- 'GI.Gio.Objects.Socket.socketReceiveMessages' will return 0 (with no error set). -- -- 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. -- -- /Since: 2.48/ socketReceiveMessages :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [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, -- which may additionally contain -- <http://man7.org/linux/man-pages/man2/recv.2.html other platform specific flags> -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ number of messages received, or -1 on error. Note that the number -- of messages received may be smaller than /@numMessages@/ if in non-blocking -- mode, 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')/ socketReceiveMessages socket messages flags cancellable = liftIO $ do let numMessages = fromIntegral $ length messages socket' <- unsafeManagedPtrCastPtr socket messages' <- mapM unsafeManagedPtrGetPtr messages messages'' <- packBlockArray 28 messages' maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_receive_messages socket' messages'' numMessages flags maybeCancellable touchManagedPtr socket mapM_ touchManagedPtr messages whenJust cancellable touchManagedPtr freeMem messages'' return result ) (do freeMem messages'' ) #if defined(ENABLE_OVERLOADING) data SocketReceiveMessagesMethodInfo instance (signature ~ ([Gio.InputMessage.InputMessage] -> Int32 -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketReceiveMessagesMethodInfo a signature where overloadedMethod = socketReceiveMessages #endif -- method Socket::receive_with_blocking -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 2 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a buffer to\n read data into (which should be at least @size bytes long)." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "blocking" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "whether to do blocking or non-blocking I/O" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the number of bytes you want to read from the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_receive_with_blocking" g_socket_receive_with_blocking :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Word8 -> -- buffer : TCArray False (-1) 2 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 CInt -> -- blocking : TBasicType TBoolean Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | This behaves exactly the same as 'GI.Gio.Objects.Socket.socketReceive', except that -- the choice of blocking or non-blocking behavior is determined by -- the /@blocking@/ argument rather than by /@socket@/\'s properties. -- -- /Since: 2.26/ socketReceiveWithBlocking :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> ByteString -- ^ /@buffer@/: a buffer to -- read data into (which should be at least /@size@/ bytes long). -> Bool -- ^ /@blocking@/: whether to do blocking or non-blocking I\/O -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes read, or 0 if the connection was closed by -- the peer, or -1 on error /(Can throw 'Data.GI.Base.GError.GError')/ socketReceiveWithBlocking socket buffer blocking cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket buffer' <- packByteString buffer let blocking' = (fromIntegral . fromEnum) blocking maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_receive_with_blocking socket' buffer' size blocking' maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr freeMem buffer' return result ) (do freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketReceiveWithBlockingMethodInfo instance (signature ~ (ByteString -> Bool -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketReceiveWithBlockingMethodInfo a signature where overloadedMethod = socketReceiveWithBlocking #endif -- method Socket::send -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 2 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the buffer\n containing the data to send." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_send" g_socket_send :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Word8 -> -- buffer : TCArray False (-1) 2 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Tries to send /@size@/ bytes from /@buffer@/ on the socket. This is -- mainly used by connection-oriented sockets; it is identical to -- 'GI.Gio.Objects.Socket.socketSendTo' with /@address@/ set to 'P.Nothing'. -- -- If the socket is in blocking mode the call will block until there is -- space for the data in the socket queue. If there is no space available -- and the socket is in non-blocking mode a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error -- will be returned. To be notified when space is available, wait for the -- 'GI.GLib.Flags.IOConditionOut' condition. Note though that you may still receive -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' from 'GI.Gio.Objects.Socket.socketSend' even if you were previously -- notified of a 'GI.GLib.Flags.IOConditionOut' condition. (On Windows in particular, this is -- very common due to the way the underlying APIs work.) -- -- On error -1 is returned and /@error@/ is set accordingly. -- -- /Since: 2.22/ socketSend :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> ByteString -- ^ /@buffer@/: the buffer -- containing the data to send. -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes written (which may be less than /@size@/), or -1 -- on error /(Can throw 'Data.GI.Base.GError.GError')/ socketSend socket buffer cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket buffer' <- packByteString buffer maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send socket' buffer' size maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr freeMem buffer' return result ) (do freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketSendMethodInfo instance (signature ~ (ByteString -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketSendMethodInfo a signature where overloadedMethod = socketSend #endif -- method Socket::send_message -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocketAddress, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "vectors" -- , argType = -- TCArray -- False -- (-1) -- 3 -- (TInterface Name { namespace = "Gio" , name = "OutputVector" }) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an array of #GOutputVector structs" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "messages" -- , argType = -- TCArray -- False -- (-1) -- 5 -- (TInterface -- Name { namespace = "Gio" , name = "SocketControlMessage" }) -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer to an\n array of #GSocketControlMessages, or %NULL." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "number of elements in @messages, or -1." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "an int containing #GSocketMsgFlags flags, which may additionally\n contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "number of elements in @messages, or -1." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_send_message" g_socket_send_message :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.SocketAddress.SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Gio.OutputVector.OutputVector -> -- vectors : TCArray False (-1) 3 (TInterface (Name {namespace = "Gio", name = "OutputVector"})) Int32 -> -- num_vectors : TBasicType TInt Ptr (Ptr Gio.SocketControlMessage.SocketControlMessage) -> -- messages : TCArray False (-1) 5 (TInterface (Name {namespace = "Gio", name = "SocketControlMessage"})) Int32 -> -- num_messages : TBasicType TInt Int32 -> -- flags : TBasicType TInt Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Send data to /@address@/ on /@socket@/. For sending multiple messages see -- 'GI.Gio.Objects.Socket.socketSendMessages'; for easier use, see -- 'GI.Gio.Objects.Socket.socketSend' and 'GI.Gio.Objects.Socket.socketSendTo'. -- -- If /@address@/ is 'P.Nothing' then the message is sent to the default receiver -- (set by 'GI.Gio.Objects.Socket.socketConnect'). -- -- /@vectors@/ must point to an array of t'GI.Gio.Structs.OutputVector.OutputVector' structs and -- /@numVectors@/ must be the length of this array. (If /@numVectors@/ is -1, -- then /@vectors@/ is assumed to be terminated by a t'GI.Gio.Structs.OutputVector.OutputVector' with a -- 'P.Nothing' buffer pointer.) The t'GI.Gio.Structs.OutputVector.OutputVector' structs describe the buffers -- that the sent data will be gathered from. Using multiple -- @/GOutputVectors/@ is more memory-efficient than manually copying -- data from multiple sources into a single buffer, and more -- network-efficient than making multiple calls to 'GI.Gio.Objects.Socket.socketSend'. -- -- /@messages@/, if non-'P.Nothing', is taken to point to an array of /@numMessages@/ -- t'GI.Gio.Objects.SocketControlMessage.SocketControlMessage' instances. These correspond to the control -- messages to be sent on the socket. -- If /@numMessages@/ is -1 then /@messages@/ is treated as a 'P.Nothing'-terminated -- array. -- -- /@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. -- -- If the socket is in blocking mode the call will block until there is -- space for the data in the socket queue. If there is no space available -- and the socket is in non-blocking mode a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error -- will be returned. To be notified when space is available, wait for the -- 'GI.GLib.Flags.IOConditionOut' condition. Note though that you may still receive -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' from 'GI.Gio.Objects.Socket.socketSend' even if you were previously -- notified of a 'GI.GLib.Flags.IOConditionOut' condition. (On Windows in particular, this is -- very common due to the way the underlying APIs work.) -- -- On error -1 is returned and /@error@/ is set accordingly. -- -- /Since: 2.22/ socketSendMessage :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Maybe (b) -- ^ /@address@/: a t'GI.Gio.Objects.SocketAddress.SocketAddress', or 'P.Nothing' -> [Gio.OutputVector.OutputVector] -- ^ /@vectors@/: an array of t'GI.Gio.Structs.OutputVector.OutputVector' structs -> Maybe ([Gio.SocketControlMessage.SocketControlMessage]) -- ^ /@messages@/: a pointer to an -- array of @/GSocketControlMessages/@, or 'P.Nothing'. -> Int32 -- ^ /@flags@/: an int containing t'GI.Gio.Flags.SocketMsgFlags' flags, which may additionally -- contain <http://man7.org/linux/man-pages/man2/recv.2.html other platform specific flags> -> Maybe (c) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes written (which may be less than /@size@/), or -1 -- on error /(Can throw 'Data.GI.Base.GError.GError')/ socketSendMessage socket address vectors messages flags cancellable = liftIO $ do let numMessages = case messages of Nothing -> 0 Just jMessages -> fromIntegral $ length jMessages let numVectors = fromIntegral $ length vectors socket' <- unsafeManagedPtrCastPtr socket maybeAddress <- case address of Nothing -> return nullPtr Just jAddress -> do jAddress' <- unsafeManagedPtrCastPtr jAddress return jAddress' vectors' <- mapM unsafeManagedPtrGetPtr vectors vectors'' <- packBlockArray 8 vectors' maybeMessages <- case messages of Nothing -> return nullPtr Just jMessages -> do jMessages' <- mapM unsafeManagedPtrCastPtr jMessages jMessages'' <- packPtrArray jMessages' return jMessages'' maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send_message socket' maybeAddress vectors'' numVectors maybeMessages numMessages flags maybeCancellable touchManagedPtr socket whenJust address touchManagedPtr mapM_ touchManagedPtr vectors whenJust messages (mapM_ touchManagedPtr) whenJust cancellable touchManagedPtr freeMem vectors'' freeMem maybeMessages return result ) (do freeMem vectors'' freeMem maybeMessages ) #if defined(ENABLE_OVERLOADING) data SocketSendMessageMethodInfo instance (signature ~ (Maybe (b) -> [Gio.OutputVector.OutputVector] -> Maybe ([Gio.SocketControlMessage.SocketControlMessage]) -> Int32 -> Maybe (c) -> m Int32), MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => O.MethodInfo SocketSendMessageMethodInfo a signature where overloadedMethod = socketSendMessage #endif -- method Socket::send_message_with_timeout -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocketAddress, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "vectors" -- , argType = -- TCArray -- False -- (-1) -- 3 -- (TInterface Name { namespace = "Gio" , name = "OutputVector" }) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "an array of #GOutputVector structs" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "messages" -- , argType = -- TCArray -- False -- (-1) -- 5 -- (TInterface -- Name { namespace = "Gio" , name = "SocketControlMessage" }) -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "a pointer to an\n array of #GSocketControlMessages, or %NULL." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "number of elements in @messages, or -1." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "an int containing #GSocketMsgFlags flags, which may additionally\n contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout_us" -- , argType = TBasicType TInt64 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the maximum time (in microseconds) to wait, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "bytes_written" -- , argType = TBasicType TUInt32 -- , direction = DirectionOut -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "location to store the number of bytes that were written to the socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferEverything -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "num_messages" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "number of elements in @messages, or -1." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "num_vectors" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of elements in @vectors, or -1" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just -- (TInterface Name { namespace = "Gio" , name = "PollableReturn" }) -- throws : True -- Skip return : False foreign import ccall "g_socket_send_message_with_timeout" g_socket_send_message_with_timeout :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.SocketAddress.SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Gio.OutputVector.OutputVector -> -- vectors : TCArray False (-1) 3 (TInterface (Name {namespace = "Gio", name = "OutputVector"})) Int32 -> -- num_vectors : TBasicType TInt Ptr (Ptr Gio.SocketControlMessage.SocketControlMessage) -> -- messages : TCArray False (-1) 5 (TInterface (Name {namespace = "Gio", name = "SocketControlMessage"})) Int32 -> -- num_messages : TBasicType TInt Int32 -> -- flags : TBasicType TInt Int64 -> -- timeout_us : TBasicType TInt64 Ptr Word32 -> -- bytes_written : TBasicType TUInt32 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO CInt -- | This behaves exactly the same as 'GI.Gio.Objects.Socket.socketSendMessage', except that -- the choice of timeout behavior is determined by the /@timeoutUs@/ argument -- rather than by /@socket@/\'s properties. -- -- On error 'GI.Gio.Enums.PollableReturnFailed' is returned and /@error@/ is set accordingly, or -- if the socket is currently not writable 'GI.Gio.Enums.PollableReturnWouldBlock' is -- returned. /@bytesWritten@/ will contain 0 in both cases. -- -- /Since: 2.60/ socketSendMessageWithTimeout :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Maybe (b) -- ^ /@address@/: a t'GI.Gio.Objects.SocketAddress.SocketAddress', or 'P.Nothing' -> [Gio.OutputVector.OutputVector] -- ^ /@vectors@/: an array of t'GI.Gio.Structs.OutputVector.OutputVector' structs -> Maybe ([Gio.SocketControlMessage.SocketControlMessage]) -- ^ /@messages@/: a pointer to an -- array of @/GSocketControlMessages/@, or 'P.Nothing'. -> Int32 -- ^ /@flags@/: an int containing t'GI.Gio.Flags.SocketMsgFlags' flags, which may additionally -- contain <http://man7.org/linux/man-pages/man2/recv.2.html other platform specific flags> -> Int64 -- ^ /@timeoutUs@/: the maximum time (in microseconds) to wait, or -1 -> Maybe (c) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m ((Gio.Enums.PollableReturn, Word32)) -- ^ __Returns:__ 'GI.Gio.Enums.PollableReturnOk' if all data was successfully written, -- 'GI.Gio.Enums.PollableReturnWouldBlock' if the socket is currently not writable, or -- 'GI.Gio.Enums.PollableReturnFailed' if an error happened and /@error@/ is set. /(Can throw 'Data.GI.Base.GError.GError')/ socketSendMessageWithTimeout socket address vectors messages flags timeoutUs cancellable = liftIO $ do let numMessages = case messages of Nothing -> 0 Just jMessages -> fromIntegral $ length jMessages let numVectors = fromIntegral $ length vectors socket' <- unsafeManagedPtrCastPtr socket maybeAddress <- case address of Nothing -> return nullPtr Just jAddress -> do jAddress' <- unsafeManagedPtrCastPtr jAddress return jAddress' vectors' <- mapM unsafeManagedPtrGetPtr vectors vectors'' <- packBlockArray 8 vectors' maybeMessages <- case messages of Nothing -> return nullPtr Just jMessages -> do jMessages' <- mapM unsafeManagedPtrCastPtr jMessages jMessages'' <- packPtrArray jMessages' return jMessages'' bytesWritten <- allocMem :: IO (Ptr Word32) maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send_message_with_timeout socket' maybeAddress vectors'' numVectors maybeMessages numMessages flags timeoutUs bytesWritten maybeCancellable let result' = (toEnum . fromIntegral) result bytesWritten' <- peek bytesWritten touchManagedPtr socket whenJust address touchManagedPtr mapM_ touchManagedPtr vectors whenJust messages (mapM_ touchManagedPtr) whenJust cancellable touchManagedPtr freeMem vectors'' freeMem maybeMessages freeMem bytesWritten return (result', bytesWritten') ) (do freeMem vectors'' freeMem maybeMessages freeMem bytesWritten ) #if defined(ENABLE_OVERLOADING) data SocketSendMessageWithTimeoutMethodInfo instance (signature ~ (Maybe (b) -> [Gio.OutputVector.OutputVector] -> Maybe ([Gio.SocketControlMessage.SocketControlMessage]) -> Int32 -> Int64 -> Maybe (c) -> m ((Gio.Enums.PollableReturn, Word32))), MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => O.MethodInfo SocketSendMessageWithTimeoutMethodInfo a signature where overloadedMethod = socketSendMessageWithTimeout #endif -- method Socket::send_messages -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , 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 -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "flags" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "an int containing #GSocketMsgFlags flags, which may additionally\n contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = 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 -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt) -- throws : True -- Skip return : False foreign import ccall "g_socket_send_messages" g_socket_send_messages :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.OutputMessage.OutputMessage -> -- messages : TCArray False (-1) 2 (TInterface (Name {namespace = "Gio", name = "OutputMessage"})) Word32 -> -- num_messages : TBasicType TUInt Int32 -> -- flags : TBasicType TInt Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Send multiple data messages from /@socket@/ in one go. This is the most -- complicated and fully-featured version of this call. For easier use, see -- 'GI.Gio.Objects.Socket.socketSend', 'GI.Gio.Objects.Socket.socketSendTo', and 'GI.Gio.Objects.Socket.socketSendMessage'. -- -- /@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. Using multiple @/GOutputVectors/@ is -- more memory-efficient than manually copying data from multiple sources -- into a single buffer, and more network-efficient than making multiple -- calls to 'GI.Gio.Objects.Socket.socketSend'. Sending multiple messages in one go avoids the -- overhead of making a lot of syscalls in scenarios where a lot of data -- packets need to be sent (e.g. high-bandwidth video streaming over RTP\/UDP), -- or where the same data needs to be sent to multiple recipients. -- -- /@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. -- -- If the socket is in blocking mode the call will block until there is -- space for all the data in the socket queue. If there is no space available -- and the socket is in non-blocking mode a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error -- will be returned if no data was written at all, otherwise the number of -- messages sent will be returned. To be notified when space is available, -- wait for the 'GI.GLib.Flags.IOConditionOut' condition. Note though that you may still receive -- 'GI.Gio.Enums.IOErrorEnumWouldBlock' from 'GI.Gio.Objects.Socket.socketSend' even if you were previously -- notified of a 'GI.GLib.Flags.IOConditionOut' condition. (On Windows in particular, this is -- very common due to the way the underlying APIs work.) -- -- 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. -- -- /Since: 2.44/ socketSendMessages :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> [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, which may additionally -- contain <http://man7.org/linux/man-pages/man2/recv.2.html other platform specific flags> -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ number of messages sent, or -1 on error. Note that the number of -- messages sent may be smaller than /@numMessages@/ if the socket is -- non-blocking 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')/ socketSendMessages socket messages flags cancellable = liftIO $ do let numMessages = fromIntegral $ length messages socket' <- unsafeManagedPtrCastPtr socket messages' <- mapM unsafeManagedPtrGetPtr messages messages'' <- packBlockArray 24 messages' maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send_messages socket' messages'' numMessages flags maybeCancellable touchManagedPtr socket mapM_ touchManagedPtr messages whenJust cancellable touchManagedPtr freeMem messages'' return result ) (do freeMem messages'' ) #if defined(ENABLE_OVERLOADING) data SocketSendMessagesMethodInfo instance (signature ~ ([Gio.OutputMessage.OutputMessage] -> Int32 -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketSendMessagesMethodInfo a signature where overloadedMethod = socketSendMessages #endif -- method Socket::send_to -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "address" -- , argType = -- TInterface Name { namespace = "Gio" , name = "SocketAddress" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocketAddress, or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 3 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the buffer\n containing the data to send." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_send_to" g_socket_send_to :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Gio.SocketAddress.SocketAddress -> -- address : TInterface (Name {namespace = "Gio", name = "SocketAddress"}) Ptr Word8 -> -- buffer : TCArray False (-1) 3 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | Tries to send /@size@/ bytes from /@buffer@/ to /@address@/. If /@address@/ is -- 'P.Nothing' then the message is sent to the default receiver (set by -- 'GI.Gio.Objects.Socket.socketConnect'). -- -- See 'GI.Gio.Objects.Socket.socketSend' for additional information. -- -- /Since: 2.22/ socketSendTo :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Maybe (b) -- ^ /@address@/: a t'GI.Gio.Objects.SocketAddress.SocketAddress', or 'P.Nothing' -> ByteString -- ^ /@buffer@/: the buffer -- containing the data to send. -> Maybe (c) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes written (which may be less than /@size@/), or -1 -- on error /(Can throw 'Data.GI.Base.GError.GError')/ socketSendTo socket address buffer cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket maybeAddress <- case address of Nothing -> return nullPtr Just jAddress -> do jAddress' <- unsafeManagedPtrCastPtr jAddress return jAddress' buffer' <- packByteString buffer maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send_to socket' maybeAddress buffer' size maybeCancellable touchManagedPtr socket whenJust address touchManagedPtr whenJust cancellable touchManagedPtr freeMem buffer' return result ) (do freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketSendToMethodInfo instance (signature ~ (Maybe (b) -> ByteString -> Maybe (c) -> m Int32), MonadIO m, IsSocket a, Gio.SocketAddress.IsSocketAddress b, Gio.Cancellable.IsCancellable c) => O.MethodInfo SocketSendToMethodInfo a signature where overloadedMethod = socketSendTo #endif -- method Socket::send_with_blocking -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "buffer" -- , argType = TCArray False (-1) 2 (TBasicType TUInt8) -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the buffer\n containing the data to send." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "blocking" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "whether to do blocking or non-blocking I/O" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "cancellable" -- , argType = -- TInterface Name { namespace = "Gio" , name = "Cancellable" } -- , direction = DirectionIn -- , mayBeNull = True -- , argDoc = -- Documentation -- { rawDocText = Just "a %GCancellable or %NULL" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [ Arg -- { argCName = "size" -- , argType = TBasicType TUInt32 -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the number of bytes to send" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- returnType: Just (TBasicType TInt32) -- throws : True -- Skip return : False foreign import ccall "g_socket_send_with_blocking" g_socket_send_with_blocking :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Ptr Word8 -> -- buffer : TCArray False (-1) 2 (TBasicType TUInt8) Word32 -> -- size : TBasicType TUInt32 CInt -> -- blocking : TBasicType TBoolean Ptr Gio.Cancellable.Cancellable -> -- cancellable : TInterface (Name {namespace = "Gio", name = "Cancellable"}) Ptr (Ptr GError) -> -- error IO Int32 -- | This behaves exactly the same as 'GI.Gio.Objects.Socket.socketSend', except that -- the choice of blocking or non-blocking behavior is determined by -- the /@blocking@/ argument rather than by /@socket@/\'s properties. -- -- /Since: 2.26/ socketSendWithBlocking :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> ByteString -- ^ /@buffer@/: the buffer -- containing the data to send. -> Bool -- ^ /@blocking@/: whether to do blocking or non-blocking I\/O -> Maybe (b) -- ^ /@cancellable@/: a @/GCancellable/@ or 'P.Nothing' -> m Int32 -- ^ __Returns:__ Number of bytes written (which may be less than /@size@/), or -1 -- on error /(Can throw 'Data.GI.Base.GError.GError')/ socketSendWithBlocking socket buffer blocking cancellable = liftIO $ do let size = fromIntegral $ B.length buffer socket' <- unsafeManagedPtrCastPtr socket buffer' <- packByteString buffer let blocking' = (fromIntegral . fromEnum) blocking maybeCancellable <- case cancellable of Nothing -> return nullPtr Just jCancellable -> do jCancellable' <- unsafeManagedPtrCastPtr jCancellable return jCancellable' onException (do result <- propagateGError $ g_socket_send_with_blocking socket' buffer' size blocking' maybeCancellable touchManagedPtr socket whenJust cancellable touchManagedPtr freeMem buffer' return result ) (do freeMem buffer' ) #if defined(ENABLE_OVERLOADING) data SocketSendWithBlockingMethodInfo instance (signature ~ (ByteString -> Bool -> Maybe (b) -> m Int32), MonadIO m, IsSocket a, Gio.Cancellable.IsCancellable b) => O.MethodInfo SocketSendWithBlockingMethodInfo a signature where overloadedMethod = socketSendWithBlocking #endif -- method Socket::set_blocking -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "blocking" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "Whether to use blocking I/O or not." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_blocking" g_socket_set_blocking :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CInt -> -- blocking : TBasicType TBoolean IO () -- | Sets the blocking mode of the socket. In blocking mode -- all operations (which don’t take an explicit blocking parameter) block until -- they succeed or there is an error. In -- non-blocking mode all functions return results immediately or -- with a 'GI.Gio.Enums.IOErrorEnumWouldBlock' error. -- -- All sockets are created in blocking mode. However, note that the -- platform level socket is always non-blocking, and blocking mode -- is a GSocket level feature. -- -- /Since: 2.22/ socketSetBlocking :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Bool -- ^ /@blocking@/: Whether to use blocking I\/O or not. -> m () socketSetBlocking socket blocking = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let blocking' = (fromIntegral . fromEnum) blocking g_socket_set_blocking socket' blocking' touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetBlockingMethodInfo instance (signature ~ (Bool -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetBlockingMethodInfo a signature where overloadedMethod = socketSetBlocking #endif -- method Socket::set_broadcast -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "broadcast" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "whether @socket should allow sending to broadcast\n addresses" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_broadcast" g_socket_set_broadcast :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CInt -> -- broadcast : TBasicType TBoolean IO () -- | Sets whether /@socket@/ should allow sending to broadcast addresses. -- This is 'P.False' by default. -- -- /Since: 2.32/ socketSetBroadcast :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Bool -- ^ /@broadcast@/: whether /@socket@/ should allow sending to broadcast -- addresses -> m () socketSetBroadcast socket broadcast = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let broadcast' = (fromIntegral . fromEnum) broadcast g_socket_set_broadcast socket' broadcast' touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetBroadcastMethodInfo instance (signature ~ (Bool -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetBroadcastMethodInfo a signature where overloadedMethod = socketSetBroadcast #endif -- method Socket::set_keepalive -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "keepalive" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "Value for the keepalive flag" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_keepalive" g_socket_set_keepalive :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CInt -> -- keepalive : TBasicType TBoolean IO () -- | Sets or unsets the @/SO_KEEPALIVE/@ flag on the underlying socket. When -- this flag is set on a socket, the system will attempt to verify that the -- remote socket endpoint is still present if a sufficiently long period of -- time passes with no data being exchanged. If the system is unable to -- verify the presence of the remote endpoint, it will automatically close -- the connection. -- -- This option is only functional on certain kinds of sockets. (Notably, -- 'GI.Gio.Enums.SocketProtocolTcp' sockets.) -- -- The exact time between pings is system- and protocol-dependent, but will -- normally be at least two hours. Most commonly, you would set this flag -- on a server socket if you want to allow clients to remain idle for long -- periods of time, but also want to ensure that connections are eventually -- garbage-collected if clients crash or become unreachable. -- -- /Since: 2.22/ socketSetKeepalive :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Bool -- ^ /@keepalive@/: Value for the keepalive flag -> m () socketSetKeepalive socket keepalive = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let keepalive' = (fromIntegral . fromEnum) keepalive g_socket_set_keepalive socket' keepalive' touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetKeepaliveMethodInfo instance (signature ~ (Bool -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetKeepaliveMethodInfo a signature where overloadedMethod = socketSetKeepalive #endif -- method Socket::set_listen_backlog -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "backlog" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the maximum number of pending connections." -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_listen_backlog" g_socket_set_listen_backlog :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Int32 -> -- backlog : TBasicType TInt IO () -- | Sets the maximum number of outstanding connections allowed -- when listening on this socket. If more clients than this are -- connecting to the socket and the application is not handling them -- on time then the new connections will be refused. -- -- Note that this must be called before 'GI.Gio.Objects.Socket.socketListen' and has no -- effect if called after that. -- -- /Since: 2.22/ socketSetListenBacklog :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Int32 -- ^ /@backlog@/: the maximum number of pending connections. -> m () socketSetListenBacklog socket backlog = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket g_socket_set_listen_backlog socket' backlog touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetListenBacklogMethodInfo instance (signature ~ (Int32 -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetListenBacklogMethodInfo a signature where overloadedMethod = socketSetListenBacklog #endif -- method Socket::set_multicast_loopback -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "loopback" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "whether @socket should receive messages sent to its\n multicast groups from the local host" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_multicast_loopback" g_socket_set_multicast_loopback :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CInt -> -- loopback : TBasicType TBoolean IO () -- | Sets whether outgoing multicast packets will be received by sockets -- listening on that multicast address on the same host. This is 'P.True' -- by default. -- -- /Since: 2.32/ socketSetMulticastLoopback :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Bool -- ^ /@loopback@/: whether /@socket@/ should receive messages sent to its -- multicast groups from the local host -> m () socketSetMulticastLoopback socket loopback = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let loopback' = (fromIntegral . fromEnum) loopback g_socket_set_multicast_loopback socket' loopback' touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetMulticastLoopbackMethodInfo instance (signature ~ (Bool -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetMulticastLoopbackMethodInfo a signature where overloadedMethod = socketSetMulticastLoopback #endif -- method Socket::set_multicast_ttl -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "ttl" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just -- "the time-to-live value for all multicast datagrams on @socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_multicast_ttl" g_socket_set_multicast_ttl :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Word32 -> -- ttl : TBasicType TUInt IO () -- | Sets the time-to-live for outgoing multicast datagrams on /@socket@/. -- By default, this is 1, meaning that multicast packets will not leave -- the local network. -- -- /Since: 2.32/ socketSetMulticastTtl :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Word32 -- ^ /@ttl@/: the time-to-live value for all multicast datagrams on /@socket@/ -> m () socketSetMulticastTtl socket ttl = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket g_socket_set_multicast_ttl socket' ttl touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetMulticastTtlMethodInfo instance (signature ~ (Word32 -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetMulticastTtlMethodInfo a signature where overloadedMethod = socketSetMulticastTtl #endif -- method Socket::set_option -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "level" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the \"API level\" of the option (eg, `SOL_SOCKET`)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "optname" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the \"name\" of the option (eg, `SO_BROADCAST`)" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "value" -- , argType = TBasicType TInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "the value to set the option to" -- , 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_set_option" g_socket_set_option :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Int32 -> -- level : TBasicType TInt Int32 -> -- optname : TBasicType TInt Int32 -> -- value : TBasicType TInt Ptr (Ptr GError) -> -- error IO CInt -- | Sets the value of an integer-valued option on /@socket@/, as with -- @/setsockopt()/@. (If you need to set a non-integer-valued option, -- you will need to call @/setsockopt()/@ directly.) -- -- The [\<gio\/gnetworking.h>][gio-gnetworking.h] -- header pulls in system headers that will define most of the -- standard\/portable socket options. For unusual socket protocols or -- platform-dependent options, you may need to include additional -- headers. -- -- /Since: 2.36/ socketSetOption :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Int32 -- ^ /@level@/: the \"API level\" of the option (eg, @SOL_SOCKET@) -> Int32 -- ^ /@optname@/: the \"name\" of the option (eg, @SO_BROADCAST@) -> Int32 -- ^ /@value@/: the value to set the option to -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketSetOption socket level optname value = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket onException (do _ <- propagateGError $ g_socket_set_option socket' level optname value touchManagedPtr socket return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketSetOptionMethodInfo instance (signature ~ (Int32 -> Int32 -> Int32 -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetOptionMethodInfo a signature where overloadedMethod = socketSetOption #endif -- method Socket::set_timeout -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "timeout" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the timeout for @socket, in seconds, or 0 for none" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_timeout" g_socket_set_timeout :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Word32 -> -- timeout : TBasicType TUInt IO () -- | Sets the time in seconds after which I\/O operations on /@socket@/ will -- time out if they have not yet completed. -- -- On a blocking socket, this means that any blocking t'GI.Gio.Objects.Socket.Socket' -- operation will time out after /@timeout@/ seconds of inactivity, -- returning 'GI.Gio.Enums.IOErrorEnumTimedOut'. -- -- On a non-blocking socket, calls to 'GI.Gio.Objects.Socket.socketConditionWait' will -- also fail with 'GI.Gio.Enums.IOErrorEnumTimedOut' after the given time. Sources -- created with @/g_socket_create_source()/@ will trigger after -- /@timeout@/ seconds of inactivity, with the requested condition -- set, at which point calling 'GI.Gio.Objects.Socket.socketReceive', 'GI.Gio.Objects.Socket.socketSend', -- 'GI.Gio.Objects.Socket.socketCheckConnectResult', etc, will fail with -- 'GI.Gio.Enums.IOErrorEnumTimedOut'. -- -- If /@timeout@/ is 0 (the default), operations will never time out -- on their own. -- -- Note that if an I\/O operation is interrupted by a signal, this may -- cause the timeout to be reset. -- -- /Since: 2.26/ socketSetTimeout :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Word32 -- ^ /@timeout@/: the timeout for /@socket@/, in seconds, or 0 for none -> m () socketSetTimeout socket timeout = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket g_socket_set_timeout socket' timeout touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetTimeoutMethodInfo instance (signature ~ (Word32 -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetTimeoutMethodInfo a signature where overloadedMethod = socketSetTimeout #endif -- method Socket::set_ttl -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket." , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "ttl" -- , argType = TBasicType TUInt -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = -- Just "the time-to-live value for all unicast packets on @socket" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Nothing -- throws : False -- Skip return : False foreign import ccall "g_socket_set_ttl" g_socket_set_ttl :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) Word32 -> -- ttl : TBasicType TUInt IO () -- | Sets the time-to-live for outgoing unicast packets on /@socket@/. -- By default the platform-specific default value is used. -- -- /Since: 2.32/ socketSetTtl :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket'. -> Word32 -- ^ /@ttl@/: the time-to-live value for all unicast packets on /@socket@/ -> m () socketSetTtl socket ttl = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket g_socket_set_ttl socket' ttl touchManagedPtr socket return () #if defined(ENABLE_OVERLOADING) data SocketSetTtlMethodInfo instance (signature ~ (Word32 -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketSetTtlMethodInfo a signature where overloadedMethod = socketSetTtl #endif -- method Socket::shutdown -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "shutdown_read" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "whether to shut down the read side" -- , sinceVersion = Nothing -- } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- , Arg -- { argCName = "shutdown_write" -- , argType = TBasicType TBoolean -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "whether to shut down the write side" -- , 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_shutdown" g_socket_shutdown :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) CInt -> -- shutdown_read : TBasicType TBoolean CInt -> -- shutdown_write : TBasicType TBoolean Ptr (Ptr GError) -> -- error IO CInt -- | Shut down part or all of a full-duplex connection. -- -- If /@shutdownRead@/ is 'P.True' then the receiving side of the connection -- is shut down, and further reading is disallowed. -- -- If /@shutdownWrite@/ is 'P.True' then the sending side of the connection -- is shut down, and further writing is disallowed. -- -- It is allowed for both /@shutdownRead@/ and /@shutdownWrite@/ to be 'P.True'. -- -- One example where it is useful to shut down only one side of a connection is -- graceful disconnect for TCP connections where you close the sending side, -- then wait for the other side to close the connection, thus ensuring that the -- other side saw all sent data. -- -- /Since: 2.22/ socketShutdown :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> Bool -- ^ /@shutdownRead@/: whether to shut down the read side -> Bool -- ^ /@shutdownWrite@/: whether to shut down the write side -> m () -- ^ /(Can throw 'Data.GI.Base.GError.GError')/ socketShutdown socket shutdownRead shutdownWrite = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket let shutdownRead' = (fromIntegral . fromEnum) shutdownRead let shutdownWrite' = (fromIntegral . fromEnum) shutdownWrite onException (do _ <- propagateGError $ g_socket_shutdown socket' shutdownRead' shutdownWrite' touchManagedPtr socket return () ) (do return () ) #if defined(ENABLE_OVERLOADING) data SocketShutdownMethodInfo instance (signature ~ (Bool -> Bool -> m ()), MonadIO m, IsSocket a) => O.MethodInfo SocketShutdownMethodInfo a signature where overloadedMethod = socketShutdown #endif -- method Socket::speaks_ipv4 -- method type : OrdinaryMethod -- Args: [ Arg -- { argCName = "socket" -- , argType = TInterface Name { namespace = "Gio" , name = "Socket" } -- , direction = DirectionIn -- , mayBeNull = False -- , argDoc = -- Documentation -- { rawDocText = Just "a #GSocket" , sinceVersion = Nothing } -- , argScope = ScopeTypeInvalid -- , argClosure = -1 -- , argDestroy = -1 -- , argCallerAllocates = False -- , transfer = TransferNothing -- } -- ] -- Lengths: [] -- returnType: Just (TBasicType TBoolean) -- throws : False -- Skip return : False foreign import ccall "g_socket_speaks_ipv4" g_socket_speaks_ipv4 :: Ptr Socket -> -- socket : TInterface (Name {namespace = "Gio", name = "Socket"}) IO CInt -- | Checks if a socket is capable of speaking IPv4. -- -- IPv4 sockets are capable of speaking IPv4. On some operating systems -- and under some combinations of circumstances IPv6 sockets are also -- capable of speaking IPv4. See RFC 3493 section 3.7 for more -- information. -- -- No other types of sockets are currently considered as being capable -- of speaking IPv4. -- -- /Since: 2.22/ socketSpeaksIpv4 :: (B.CallStack.HasCallStack, MonadIO m, IsSocket a) => a -- ^ /@socket@/: a t'GI.Gio.Objects.Socket.Socket' -> m Bool -- ^ __Returns:__ 'P.True' if this socket can be used with IPv4. socketSpeaksIpv4 socket = liftIO $ do socket' <- unsafeManagedPtrCastPtr socket result <- g_socket_speaks_ipv4 socket' let result' = (/= 0) result touchManagedPtr socket return result' #if defined(ENABLE_OVERLOADING) data SocketSpeaksIpv4MethodInfo instance (signature ~ (m Bool), MonadIO m, IsSocket a) => O.MethodInfo SocketSpeaksIpv4MethodInfo a signature where overloadedMethod = socketSpeaksIpv4 #endif