GI.Gio.Objects.Socket

A 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.

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 SocketClient, SocketService and SocketConnection. However there may be cases where direct use of Socket is useful.

Socket implements the Initable interface, so if it is manually constructed by e.g. g_object_new() you must call initableInit and check the results before using the object. This is done automatically in socketNew and socketNewFromFd, so these functions can return 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 IOErrorEnumWouldBlock error. To know when a call would successfully run you can call socketConditionCheck, or socketConditionWait. You can also use g_socket_create_source() and attach it to a 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 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 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 Socket causes the signal SIGPIPE to be ignored for the remainder of the program. If you are writing a command-line utility that uses 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, Socket is not inherently thread safe. To use a Socket concurrently from multiple threads, you must implement your own locking.

Exported types

newtype Socket

Constructors

Socket (ManagedPtr Socket)

Instances

GObject Socket

Methods

gobjectType :: Socket -> IO GType

IsObject Socket

IsSocket Socket

IsInitable Socket

IsDatagramBased Socket

((~) * info (ResolveSocketMethod t Socket), MethodInfo * info Socket p) => IsLabel t (Socket -> p)

Methods

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

((~) * info (ResolveSocketMethod t Socket), MethodInfo * info Socket p) => IsLabelProxy t (Socket -> p)

Methods

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

HasAttributeList * Socket

type AttributeList Socket

type AttributeList Socket

type SignalList Socket

type SignalList Socket

class GObject o => IsSocket o

Instances

(GObject a, UnknownAncestorError Constraint Socket a) => IsSocket a

IsSocket Socket

toSocket :: IsSocket o => o -> IO Socket

noSocket :: Maybe Socket

Methods

accept

data SocketAcceptMethodInfo

Instances

((~) * signature (Maybe b -> m Socket), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketAcceptMethodInfo a signature

Methods

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

socketAccept

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket.

-> Maybe b

cancellable: a GCancellable or Nothing

-> m Socket

Returns: a new Socket, or Nothing on error. Free the returned object with objectUnref. (Can throw GError)

Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a Socket object for it.

The socket must be bound to a local address with socketBind and must be listening for incoming connections (socketListen).

If there are no outstanding connections then the operation will block or return IOErrorEnumWouldBlock if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the IOConditionIn condition.

Since: 2.22

bind

data SocketBindMethodInfo

Instances

((~) * signature (b -> Bool -> m ()), MonadIO m, IsSocket a, IsSocketAddress b) => MethodInfo * SocketBindMethodInfo a signature

Methods

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

socketBind

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsSocketAddress b)

=> a

socket: a Socket.

-> b

address: a SocketAddress specifying the local address.

-> Bool

allowReuse: whether to allow reusing this address

-> m ()

(Can throw GError)

When a socket is created it is attached to an address family, but it doesn't have an address in this family. 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 socketListen and 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 True for server sockets (sockets that you will eventually call socketAccept on), and False for client sockets. (Failing to set this flag on a server socket may cause socketBind to return 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

checkConnectResult

data SocketCheckConnectResultMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsSocket a) => MethodInfo * SocketCheckConnectResultMethodInfo a signature

Methods

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

socketCheckConnectResult

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m ()

(Can throw GError)

Checks and resets the pending connect error for the socket. This is used to check for errors when socketConnect is used in non-blocking mode.

Since: 2.22

close

data SocketCloseMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsSocket a) => MethodInfo * SocketCloseMethodInfo a signature

Methods

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

socketClose

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m ()

(Can throw GError)

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 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 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 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 socketClose. (This is what TcpConnection does if you call tcpConnectionSetGracefulDisconnect. But of course, this only works if the client will close its connection after the server does.)

Since: 2.22

conditionCheck

data SocketConditionCheckMethodInfo

Instances

((~) * signature ([IOCondition] -> m [IOCondition]), MonadIO m, IsSocket a) => MethodInfo * SocketConditionCheckMethodInfo a signature

Methods

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

socketConditionCheck

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> [IOCondition]

condition: a IOCondition mask to check

-> m [IOCondition]

Returns: the gIOCondition mask of the current state

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 IOErrorEnumWouldBlock even immediately after socketConditionCheck has claimed that the socket is ready for writing. Rather than calling 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 IOErrorEnumWouldBlock.

It is meaningless to specify IOConditionErr or IOConditionHup in condition; these conditions will always be set in the output if they are true.

This call never blocks.

Since: 2.22

conditionTimedWait

data SocketConditionTimedWaitMethodInfo

Instances

((~) * signature ([IOCondition] -> Int64 -> Maybe b -> m ()), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketConditionTimedWaitMethodInfo a signature

Methods

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

socketConditionTimedWait

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> [IOCondition]

condition: a IOCondition mask to wait for

-> Int64

timeout: the maximum time (in microseconds) to wait, or -1

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Waits for up to timeout microseconds for condition to become true on socket. If the condition is met, True is returned.

If cancellable is cancelled before the condition is met, or if timeout (or the socket's Socket:timeout) is reached before the condition is met, then False is returned and error, if non-Nothing, is set to the appropriate value (IOErrorEnumCancelled or IOErrorEnumTimedOut).

If you don't want a timeout, use socketConditionWait. (Alternatively, you can pass -1 for timeout.)

Note that although timeout is in microseconds for consistency with other GLib APIs, this function actually only has millisecond resolution, and the behavior is undefined if timeout is not an exact number of milliseconds.

Since: 2.32

conditionWait

data SocketConditionWaitMethodInfo

Instances

((~) * signature ([IOCondition] -> Maybe b -> m ()), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketConditionWaitMethodInfo a signature

Methods

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

socketConditionWait

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> [IOCondition]

condition: a IOCondition mask to wait for

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Waits for condition to become true on socket. When the condition is met, 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 False is returned and error, if non-Nothing, is set to the appropriate value (IOErrorEnumCancelled or IOErrorEnumTimedOut).

See also socketConditionTimedWait.

Since: 2.22

connect

data SocketConnectMethodInfo

Instances

((~) * signature (b -> Maybe c -> m ()), MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c) => MethodInfo * SocketConnectMethodInfo a signature

Methods

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

socketConnect

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c)

=> a

socket: a Socket.

-> b

address: a SocketAddress specifying the remote address.

-> Maybe c

cancellable: a GCancellable or Nothing

-> m ()

(Can throw GError)

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 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 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 socketCheckConnectResult.

Since: 2.22

connectionFactoryCreateConnection

data SocketConnectionFactoryCreateConnectionMethodInfo

Instances

((~) * signature (m SocketConnection), MonadIO m, IsSocket a) => MethodInfo * SocketConnectionFactoryCreateConnectionMethodInfo a signature

Methods

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

socketConnectionFactoryCreateConnection

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m SocketConnection

Returns: a SocketConnection

Creates a SocketConnection subclass of the right type for socket.

Since: 2.22

getAvailableBytes

data SocketGetAvailableBytesMethodInfo

Instances

((~) * signature (m Int64), MonadIO m, IsSocket a) => MethodInfo * SocketGetAvailableBytesMethodInfo a signature

Methods

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

socketGetAvailableBytes

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m Int64

Returns: the number of bytes that can be read from the socket without blocking or truncating, or -1 on error.

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 socketReceive with a buffer of that size, rather than calling socketGetAvailableBytes first and then doing a receive of exactly the right size.

Since: 2.32

getBlocking

data SocketGetBlockingMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketGetBlockingMethodInfo a signature

Methods

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

socketGetBlocking

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Bool

Returns: True if blocking I/O is used, False otherwise.

Gets the blocking mode of the socket. For details on blocking I/O, see socketSetBlocking.

Since: 2.22

getBroadcast

data SocketGetBroadcastMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketGetBroadcastMethodInfo a signature

Methods

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

socketGetBroadcast

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Bool

Returns: the broadcast setting on socket

Gets the broadcast setting on socket; if True, it is possible to send packets to broadcast addresses.

Since: 2.32

getCredentials

data SocketGetCredentialsMethodInfo

Instances

((~) * signature (m Credentials), MonadIO m, IsSocket a) => MethodInfo * SocketGetCredentialsMethodInfo a signature

Methods

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

socketGetCredentials

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Credentials

Returns: Nothing if error is set, otherwise a Credentials object that must be freed with objectUnref. (Can throw GError)

Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for SocketFamilyUnix sockets).

If this operation isn't supported on the OS, the method fails with the IOErrorEnumNotSupported error. On Linux this is implemented by reading the SO_PEERCRED option on the underlying socket.

Other ways to obtain credentials from a foreign peer includes the UnixCredentialsMessage type and unixConnectionSendCredentials / unixConnectionReceiveCredentials functions.

Since: 2.26

getFamily

data SocketGetFamilyMethodInfo

Instances

((~) * signature (m SocketFamily), MonadIO m, IsSocket a) => MethodInfo * SocketGetFamilyMethodInfo a signature

Methods

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

socketGetFamily

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m SocketFamily

Returns: a SocketFamily

Gets the socket family of the socket.

Since: 2.22

getFd

data SocketGetFdMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsSocket a) => MethodInfo * SocketGetFdMethodInfo a signature

Methods

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

socketGetFd

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Int32

Returns: the file descriptor of the socket.

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

getKeepalive

data SocketGetKeepaliveMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketGetKeepaliveMethodInfo a signature

Methods

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

socketGetKeepalive

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Bool

Returns: True if keepalive is active, False otherwise.

Gets the keepalive mode of the socket. For details on this, see socketSetKeepalive.

Since: 2.22

getListenBacklog

data SocketGetListenBacklogMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsSocket a) => MethodInfo * SocketGetListenBacklogMethodInfo a signature

Methods

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

socketGetListenBacklog

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Int32

Returns: the maximum number of pending connections.

Gets the listen backlog setting of the socket. For details on this, see socketSetListenBacklog.

Since: 2.22

getLocalAddress

data SocketGetLocalAddressMethodInfo

Instances

((~) * signature (m SocketAddress), MonadIO m, IsSocket a) => MethodInfo * SocketGetLocalAddressMethodInfo a signature

Methods

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

socketGetLocalAddress

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m SocketAddress

Returns: a SocketAddress or Nothing on error. Free the returned object with objectUnref. (Can throw GError)

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

getMulticastLoopback

data SocketGetMulticastLoopbackMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketGetMulticastLoopbackMethodInfo a signature

Methods

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

socketGetMulticastLoopback

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Bool

Returns: the multicast loopback setting on socket

Gets the multicast loopback setting on socket; if True (the default), outgoing multicast packets will be looped back to multicast listeners on the same host.

Since: 2.32

getMulticastTtl

data SocketGetMulticastTtlMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsSocket a) => MethodInfo * SocketGetMulticastTtlMethodInfo a signature

Methods

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

socketGetMulticastTtl

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Word32

Returns: the multicast time-to-live setting on socket

Gets the multicast time-to-live setting on socket; see socketSetMulticastTtl for more details.

Since: 2.32

getOption

data SocketGetOptionMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> m Int32), MonadIO m, IsSocket a) => MethodInfo * SocketGetOptionMethodInfo a signature

Methods

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

socketGetOption

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a 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 GError)

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; socketGetOption will handle the conversion internally.

Since: 2.36

getProtocol

data SocketGetProtocolMethodInfo

Instances

((~) * signature (m SocketProtocol), MonadIO m, IsSocket a) => MethodInfo * SocketGetProtocolMethodInfo a signature

Methods

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

socketGetProtocol

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m SocketProtocol

Returns: a protocol id, or -1 if unknown

Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned.

Since: 2.22

getRemoteAddress

data SocketGetRemoteAddressMethodInfo

Instances

((~) * signature (m SocketAddress), MonadIO m, IsSocket a) => MethodInfo * SocketGetRemoteAddressMethodInfo a signature

Methods

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

socketGetRemoteAddress

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m SocketAddress

Returns: a SocketAddress or Nothing on error. Free the returned object with objectUnref. (Can throw GError)

Try to get the remove address of a connected socket. This is only useful for connection oriented sockets that have been connected.

Since: 2.22

getSocketType

data SocketGetSocketTypeMethodInfo

Instances

((~) * signature (m SocketType), MonadIO m, IsSocket a) => MethodInfo * SocketGetSocketTypeMethodInfo a signature

Methods

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

socketGetSocketType

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m SocketType

Returns: a SocketType

Gets the socket type of the socket.

Since: 2.22

getTimeout

data SocketGetTimeoutMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsSocket a) => MethodInfo * SocketGetTimeoutMethodInfo a signature

Methods

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

socketGetTimeout

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Word32

Returns: the timeout in seconds

Gets the timeout setting of the socket. For details on this, see socketSetTimeout.

Since: 2.26

getTtl

data SocketGetTtlMethodInfo

Instances

((~) * signature (m Word32), MonadIO m, IsSocket a) => MethodInfo * SocketGetTtlMethodInfo a signature

Methods

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

socketGetTtl

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Word32

Returns: the time-to-live setting on socket

Gets the unicast time-to-live setting on socket; see socketSetTtl for more details.

Since: 2.32

isClosed

data SocketIsClosedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketIsClosedMethodInfo a signature

Methods

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

socketIsClosed

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m Bool

Returns: True if socket is closed, False otherwise

Checks whether a socket is closed.

Since: 2.22

isConnected

data SocketIsConnectedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketIsConnectedMethodInfo a signature

Methods

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

socketIsConnected

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m Bool

Returns: True if socket is connected, False otherwise.

Check whether the socket is connected. This is only useful for connection-oriented sockets.

If using socketShutdown, this function will return True until the socket has been shut down for reading and writing. If you do a non-blocking connect, this function will not return True until after you call socketCheckConnectResult.

Since: 2.22

joinMulticastGroup

data SocketJoinMulticastGroupMethodInfo

Instances

((~) * signature (b -> Bool -> Maybe Text -> m ()), MonadIO m, IsSocket a, IsInetAddress b) => MethodInfo * SocketJoinMulticastGroupMethodInfo a signature

Methods

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

socketJoinMulticastGroup

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsInetAddress b)

=> a

socket: a Socket.

-> b

group: a InetAddress specifying the group address to join.

-> Bool

sourceSpecific: True if source-specific multicast should be used

-> Maybe Text

iface: Name of the interface to use, or Nothing

-> m ()

(Can throw GError)

Registers socket to receive multicast messages sent to group. socket must be a SocketTypeDatagram socket, and must have been bound to an appropriate interface and port with socketBind.

If iface is Nothing, the system will automatically pick an interface to bind to based on group.

If sourceSpecific is True, source-specific multicast as defined in RFC 4604 is used. Note that on older platforms this may fail with a IOErrorEnumNotSupported error.

Since: 2.32

leaveMulticastGroup

data SocketLeaveMulticastGroupMethodInfo

Instances

((~) * signature (b -> Bool -> Maybe Text -> m ()), MonadIO m, IsSocket a, IsInetAddress b) => MethodInfo * SocketLeaveMulticastGroupMethodInfo a signature

Methods

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

socketLeaveMulticastGroup

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsInetAddress b)

=> a

socket: a Socket.

-> b

group: a InetAddress specifying the group address to leave.

-> Bool

sourceSpecific: True if source-specific multicast was used

-> Maybe Text

iface: Interface used

-> m ()

(Can throw GError)

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.32

listen

data SocketListenMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsSocket a) => MethodInfo * SocketListenMethodInfo a signature

Methods

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

socketListen

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> m ()

(Can throw GError)

Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using socketAccept.

Before calling this the socket must be bound to a local address using socketBind.

To set the maximum amount of outstanding clients, use socketSetListenBacklog.

Since: 2.22

new

socketNew

Arguments

:: (HasCallStack, MonadIO m)

=> SocketFamily

family: the socket family to use, e.g. SocketFamilyIpv4.

-> SocketType

type: the socket type to use.

-> SocketProtocol

protocol: the id of the protocol to use, or 0 for default.

-> m Socket

Returns: a Socket or Nothing on error. Free the returned object with objectUnref. (Can throw GError)

Creates a new Socket with the defined family, type and protocol. If protocol is 0 (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. 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 SocketProtocol if you know the protocol number used for it.

Since: 2.22

newFromFd

socketNewFromFd

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

fd: a native socket file descriptor.

-> m Socket

Returns: a Socket or Nothing on error. Free the returned object with objectUnref. (Can throw GError)

Creates a new 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 Socket.

On success, the returned 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 IOErrorEnumFailed

Since: 2.22

receive

data SocketReceiveMethodInfo

Instances

((~) * signature (ByteString -> Maybe b -> m Int64), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketReceiveMethodInfo a signature

Methods

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

socketReceive

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> ByteString

buffer: a buffer to read data into (which should be at least size bytes long).

-> Maybe b

cancellable: a GCancellable or Nothing

-> m Int64

Returns: Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error (Can throw GError)

Receive data (up to size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to socketReceiveFrom with address set to Nothing.

For SocketTypeDatagram and SocketTypeSeqpacket sockets, 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 SocketTypeStream sockets, 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 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 IOErrorEnumWouldBlock error will be returned. To be notified when data is available, wait for the IOConditionIn condition.

On error -1 is returned and error is set accordingly.

Since: 2.22

receiveFrom

data SocketReceiveFromMethodInfo

Instances

((~) * signature (ByteString -> Maybe b -> m (Int64, SocketAddress)), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketReceiveFromMethodInfo a signature

Methods

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

socketReceiveFrom

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> ByteString

buffer: a buffer to read data into (which should be at least size bytes long).

-> Maybe b

cancellable: a GCancellable or Nothing

-> m (Int64, SocketAddress)

Returns: Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error (Can throw GError)

Receive data (up to size bytes) from a socket.

If address is non-Nothing then address will be set equal to the source address of the received packet. address is owned by the caller.

See socketReceive for additional information.

Since: 2.22

receiveMessage

data SocketReceiveMessageMethodInfo

Instances

((~) * signature ([InputVector] -> Int32 -> Maybe b -> m (Int64, Maybe SocketAddress, Maybe [SocketControlMessage], Int32)), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketReceiveMessageMethodInfo a signature

Methods

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

socketReceiveMessage

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> [InputVector]

vectors: an array of InputVector structs

-> Int32

flags: a pointer to an int containing SocketMsgFlags flags

-> Maybe b

cancellable: a GCancellable or Nothing

-> m (Int64, Maybe SocketAddress, Maybe [SocketControlMessage], Int32)

Returns: Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error (Can throw GError)

Receive data from a socket. For receiving multiple messages, see socketReceiveMessages; for easier use, see socketReceive and socketReceiveFrom.

If address is non-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 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 InputVector with a Nothing buffer pointer.

As a special case, if numVectors is 0 (in which case, vectors may of course be 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-Nothing, will be set to point to a newly-allocated array of SocketControlMessage instances or Nothing if no such messages was received. These correspond to the control messages received from the kernel, one SocketControlMessage per message from the kernel. This array is Nothing-terminated and must be freed by the caller using free after calling objectUnref on each element. If messages is Nothing, any control messages received will be discarded.

numMessages, if non-Nothing, will be set to the number of control messages received.

If both messages and numMessages are non-Nothing, then numMessages gives the number of SocketControlMessage instances in messages (ie: not including the Nothing terminator).

flags is an in/out parameter. The commonly available arguments for this are available in the 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 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 socketReceive, data may be discarded if socket is SocketTypeDatagram or SocketTypeSeqpacket and you do not provide enough buffer space to read a complete message. You can pass 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 IOErrorEnumWouldBlock error will be returned. To be notified when data is available, wait for the IOConditionIn condition.

On error -1 is returned and error is set accordingly.

Since: 2.22

receiveMessages

data SocketReceiveMessagesMethodInfo

Instances

((~) * signature ([InputMessage] -> Int32 -> Maybe b -> m Int32), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketReceiveMessagesMethodInfo a signature

Methods

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

socketReceiveMessages

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> [InputMessage]

messages: an array of InputMessage structs

-> Int32

flags: an int containing SocketMsgFlags flags for the overall operation

-> Maybe b

cancellable: a GCancellable or 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 GError)

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 socketReceive, socketReceiveFrom, and socketReceiveMessage.

messages must point to an array of InputMessage structs and numMessages must be the length of this array. Each InputMessage contains a pointer to an array of 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 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 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 InputMessage.flags.

The other members of InputMessage are treated as described in its documentation.

If Socket:blocking is True the call will block until numMessages have been received, or the end of the stream is reached.

If Socket:blocking is False the call will return up to numMessages without blocking, or IOErrorEnumWouldBlock if no messages are queued in the operating system to be received.

In blocking mode, if Socket:timeout is positive and is reached before any messages are received, 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 IOConditionIn condition. Note though that you may still receive IOErrorEnumWouldBlock from socketReceiveMessages even if you were previously notified of a IOConditionIn condition.

If the remote peer closes the connection, any messages queued in the operating system will be returned, and subsequent calls to 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

receiveWithBlocking

data SocketReceiveWithBlockingMethodInfo

Instances

((~) * signature (ByteString -> Bool -> Maybe b -> m Int64), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketReceiveWithBlockingMethodInfo a signature

Methods

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

socketReceiveWithBlocking

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a 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 Nothing

-> m Int64

Returns: Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error (Can throw GError)

This behaves exactly the same as 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

send

data SocketSendMethodInfo

Instances

((~) * signature (ByteString -> Maybe b -> m Int64), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketSendMethodInfo a signature

Methods

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

socketSend

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> ByteString

buffer: the buffer containing the data to send.

-> Maybe b

cancellable: a GCancellable or Nothing

-> m Int64

Returns: Number of bytes written (which may be less than size), or -1 on error (Can throw GError)

Tries to send size bytes from buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to socketSendTo with address set to 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 IOErrorEnumWouldBlock error will be returned. To be notified when space is available, wait for the IOConditionOut condition. Note though that you may still receive IOErrorEnumWouldBlock from socketSend even if you were previously notified of a 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

sendMessage

data SocketSendMessageMethodInfo

Instances

((~) * signature (Maybe b -> [OutputVector] -> Maybe [SocketControlMessage] -> Int32 -> Maybe c -> m Int64), MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c) => MethodInfo * SocketSendMessageMethodInfo a signature

Methods

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

socketSendMessage

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c)

=> a

socket: a Socket

-> Maybe b

address: a SocketAddress, or Nothing

-> [OutputVector]

vectors: an array of OutputVector structs

-> Maybe [SocketControlMessage]

messages: a pointer to an array of GSocketControlMessages, or Nothing.

-> Int32

flags: an int containing SocketMsgFlags flags

-> Maybe c

cancellable: a GCancellable or Nothing

-> m Int64

Returns: Number of bytes written (which may be less than size), or -1 on error (Can throw GError)

Send data to address on socket. For sending multiple messages see socketSendMessages; for easier use, see socketSend and socketSendTo.

If address is Nothing then the message is sent to the default receiver (set by socketConnect).

vectors must point to an array of OutputVector structs and numVectors must be the length of this array. (If numVectors is -1, then vectors is assumed to be terminated by a OutputVector with a Nothing buffer pointer.) The 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 socketSend.

messages, if non-Nothing, is taken to point to an array of numMessages SocketControlMessage instances. These correspond to the control messages to be sent on the socket. If numMessages is -1 then messages is treated as a Nothing-terminated array.

flags modify how the message is sent. The commonly available arguments for this are available in the 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 IOErrorEnumWouldBlock error will be returned. To be notified when space is available, wait for the IOConditionOut condition. Note though that you may still receive IOErrorEnumWouldBlock from socketSend even if you were previously notified of a 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

sendMessages

data SocketSendMessagesMethodInfo

Instances

((~) * signature ([OutputMessage] -> Int32 -> Maybe b -> m Int32), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketSendMessagesMethodInfo a signature

Methods

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

socketSendMessages

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a Socket

-> [OutputMessage]

messages: an array of OutputMessage structs

-> Int32

flags: an int containing SocketMsgFlags flags

-> Maybe b

cancellable: a GCancellable or 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 GError)

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 socketSend, socketSendTo, and socketSendMessage.

messages must point to an array of OutputMessage structs and numMessages must be the length of this array. Each OutputMessage contains an address to send the data to, and a pointer to an array of 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 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 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 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 IOConditionOut condition. Note though that you may still receive IOErrorEnumWouldBlock from socketSend even if you were previously notified of a 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

sendTo

data SocketSendToMethodInfo

Instances

((~) * signature (Maybe b -> ByteString -> Maybe c -> m Int64), MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c) => MethodInfo * SocketSendToMethodInfo a signature

Methods

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

socketSendTo

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsSocketAddress b, IsCancellable c)

=> a

socket: a Socket

-> Maybe b

address: a SocketAddress, or Nothing

-> ByteString

buffer: the buffer containing the data to send.

-> Maybe c

cancellable: a GCancellable or Nothing

-> m Int64

Returns: Number of bytes written (which may be less than size), or -1 on error (Can throw GError)

Tries to send size bytes from buffer to address. If address is Nothing then the message is sent to the default receiver (set by socketConnect).

See socketSend for additional information.

Since: 2.22

sendWithBlocking

data SocketSendWithBlockingMethodInfo

Instances

((~) * signature (ByteString -> Bool -> Maybe b -> m Int64), MonadIO m, IsSocket a, IsCancellable b) => MethodInfo * SocketSendWithBlockingMethodInfo a signature

Methods

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

socketSendWithBlocking

Arguments

:: (HasCallStack, MonadIO m, IsSocket a, IsCancellable b)

=> a

socket: a 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 Nothing

-> m Int64

Returns: Number of bytes written (which may be less than size), or -1 on error (Can throw GError)

This behaves exactly the same as 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

setBlocking

data SocketSetBlockingMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetBlockingMethodInfo a signature

Methods

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

socketSetBlocking

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Bool

blocking: Whether to use blocking I/O or not.

-> m ()

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 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

setBroadcast

data SocketSetBroadcastMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetBroadcastMethodInfo a signature

Methods

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

socketSetBroadcast

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Bool

broadcast: whether socket should allow sending to broadcast addresses

-> m ()

Sets whether socket should allow sending to broadcast addresses. This is False by default.

Since: 2.32

setKeepalive

data SocketSetKeepaliveMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetKeepaliveMethodInfo a signature

Methods

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

socketSetKeepalive

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Bool

keepalive: Value for the keepalive flag

-> m ()

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, 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

setListenBacklog

data SocketSetListenBacklogMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetListenBacklogMethodInfo a signature

Methods

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

socketSetListenBacklog

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Int32

backlog: the maximum number of pending connections.

-> m ()

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 socketListen and has no effect if called after that.

Since: 2.22

setMulticastLoopback

data SocketSetMulticastLoopbackMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetMulticastLoopbackMethodInfo a signature

Methods

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

socketSetMulticastLoopback

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Bool

loopback: whether socket should receive messages sent to its multicast groups from the local host

-> m ()

Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is True by default.

Since: 2.32

setMulticastTtl

data SocketSetMulticastTtlMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetMulticastTtlMethodInfo a signature

Methods

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

socketSetMulticastTtl

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Word32

ttl: the time-to-live value for all multicast datagrams on socket

-> m ()

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

setOption

data SocketSetOptionMethodInfo

Instances

((~) * signature (Int32 -> Int32 -> Int32 -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetOptionMethodInfo a signature

Methods

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

socketSetOption

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a 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 GError)

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

setTimeout

data SocketSetTimeoutMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetTimeoutMethodInfo a signature

Methods

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

socketSetTimeout

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Word32

timeout: the timeout for socket, in seconds, or 0 for none

-> m ()

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 Socket operation will time out after timeout seconds of inactivity, returning IOErrorEnumTimedOut.

On a non-blocking socket, calls to socketConditionWait will also fail with 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 socketReceive, socketSend, socketCheckConnectResult, etc, will fail with 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

setTtl

data SocketSetTtlMethodInfo

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketSetTtlMethodInfo a signature

Methods

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

socketSetTtl

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket.

-> Word32

ttl: the time-to-live value for all unicast packets on socket

-> m ()

Sets the time-to-live for outgoing unicast packets on socket. By default the platform-specific default value is used.

Since: 2.32

shutdown

data SocketShutdownMethodInfo

Instances

((~) * signature (Bool -> Bool -> m ()), MonadIO m, IsSocket a) => MethodInfo * SocketShutdownMethodInfo a signature

Methods

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

socketShutdown

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> Bool

shutdownRead: whether to shut down the read side

-> Bool

shutdownWrite: whether to shut down the write side

-> m ()

(Can throw GError)

Shut down part or all of a full-duplex connection.

If shutdownRead is True then the receiving side of the connection is shut down, and further reading is disallowed.

If shutdownWrite is 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 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

speaksIpv4

data SocketSpeaksIpv4MethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsSocket a) => MethodInfo * SocketSpeaksIpv4MethodInfo a signature

Methods

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

socketSpeaksIpv4

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

socket: a Socket

-> m Bool

Returns: True if this socket can be used with IPv4.

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

Properties

blocking

data SocketBlockingPropertyInfo

Instances

AttrInfo SocketBlockingPropertyInfo

Associated Types

type AttrAllowedOps SocketBlockingPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketBlockingPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketBlockingPropertyInfo :: * -> Constraint

type AttrGetType SocketBlockingPropertyInfo :: *

type AttrLabel SocketBlockingPropertyInfo :: Symbol

type AttrOrigin SocketBlockingPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketBlockingPropertyInfo

type AttrOrigin SocketBlockingPropertyInfo = Socket

type AttrLabel SocketBlockingPropertyInfo

type AttrLabel SocketBlockingPropertyInfo = "blocking"

type AttrGetType SocketBlockingPropertyInfo

type AttrGetType SocketBlockingPropertyInfo = Bool

type AttrBaseTypeConstraint SocketBlockingPropertyInfo

type AttrBaseTypeConstraint SocketBlockingPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketBlockingPropertyInfo

type AttrSetTypeConstraint SocketBlockingPropertyInfo = * ~ Bool

type AttrAllowedOps SocketBlockingPropertyInfo

type AttrAllowedOps SocketBlockingPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketBlocking :: IsSocket o => Bool -> IO (GValueConstruct o)

getSocketBlocking :: (MonadIO m, IsSocket o) => o -> m Bool

setSocketBlocking :: (MonadIO m, IsSocket o) => o -> Bool -> m ()

socketBlocking :: AttrLabelProxy "blocking"

broadcast

data SocketBroadcastPropertyInfo

Instances

AttrInfo SocketBroadcastPropertyInfo

Associated Types

type AttrAllowedOps SocketBroadcastPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketBroadcastPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketBroadcastPropertyInfo :: * -> Constraint

type AttrGetType SocketBroadcastPropertyInfo :: *

type AttrLabel SocketBroadcastPropertyInfo :: Symbol

type AttrOrigin SocketBroadcastPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketBroadcastPropertyInfo

type AttrOrigin SocketBroadcastPropertyInfo = Socket

type AttrLabel SocketBroadcastPropertyInfo

type AttrLabel SocketBroadcastPropertyInfo = "broadcast"

type AttrGetType SocketBroadcastPropertyInfo

type AttrGetType SocketBroadcastPropertyInfo = Bool

type AttrBaseTypeConstraint SocketBroadcastPropertyInfo

type AttrBaseTypeConstraint SocketBroadcastPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketBroadcastPropertyInfo

type AttrSetTypeConstraint SocketBroadcastPropertyInfo = * ~ Bool

type AttrAllowedOps SocketBroadcastPropertyInfo

type AttrAllowedOps SocketBroadcastPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketBroadcast :: IsSocket o => Bool -> IO (GValueConstruct o)

getSocketBroadcast :: (MonadIO m, IsSocket o) => o -> m Bool

setSocketBroadcast :: (MonadIO m, IsSocket o) => o -> Bool -> m ()

socketBroadcast :: AttrLabelProxy "broadcast"

family

data SocketFamilyPropertyInfo

Instances

AttrInfo SocketFamilyPropertyInfo

Associated Types

type AttrAllowedOps SocketFamilyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketFamilyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketFamilyPropertyInfo :: * -> Constraint

type AttrGetType SocketFamilyPropertyInfo :: *

type AttrLabel SocketFamilyPropertyInfo :: Symbol

type AttrOrigin SocketFamilyPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketFamilyPropertyInfo

type AttrOrigin SocketFamilyPropertyInfo = Socket

type AttrLabel SocketFamilyPropertyInfo

type AttrLabel SocketFamilyPropertyInfo = "family"

type AttrGetType SocketFamilyPropertyInfo

type AttrGetType SocketFamilyPropertyInfo = SocketFamily

type AttrBaseTypeConstraint SocketFamilyPropertyInfo

type AttrBaseTypeConstraint SocketFamilyPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketFamilyPropertyInfo

type AttrSetTypeConstraint SocketFamilyPropertyInfo = * ~ SocketFamily

type AttrAllowedOps SocketFamilyPropertyInfo

type AttrAllowedOps SocketFamilyPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructSocketFamily :: IsSocket o => SocketFamily -> IO (GValueConstruct o)

getSocketFamily :: (MonadIO m, IsSocket o) => o -> m SocketFamily

socketFamily :: AttrLabelProxy "family"

fd

data SocketFdPropertyInfo

Instances

AttrInfo SocketFdPropertyInfo

Associated Types

type AttrAllowedOps SocketFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketFdPropertyInfo :: * -> Constraint

type AttrGetType SocketFdPropertyInfo :: *

type AttrLabel SocketFdPropertyInfo :: Symbol

type AttrOrigin SocketFdPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketFdPropertyInfo

type AttrOrigin SocketFdPropertyInfo = Socket

type AttrLabel SocketFdPropertyInfo

type AttrLabel SocketFdPropertyInfo = "fd"

type AttrGetType SocketFdPropertyInfo

type AttrGetType SocketFdPropertyInfo = Int32

type AttrBaseTypeConstraint SocketFdPropertyInfo

type AttrBaseTypeConstraint SocketFdPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketFdPropertyInfo

type AttrSetTypeConstraint SocketFdPropertyInfo = * ~ Int32

type AttrAllowedOps SocketFdPropertyInfo

type AttrAllowedOps SocketFdPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructSocketFd :: IsSocket o => Int32 -> IO (GValueConstruct o)

getSocketFd :: (MonadIO m, IsSocket o) => o -> m Int32

socketFd :: AttrLabelProxy "fd"

keepalive

data SocketKeepalivePropertyInfo

Instances

AttrInfo SocketKeepalivePropertyInfo

Associated Types

type AttrAllowedOps SocketKeepalivePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketKeepalivePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketKeepalivePropertyInfo :: * -> Constraint

type AttrGetType SocketKeepalivePropertyInfo :: *

type AttrLabel SocketKeepalivePropertyInfo :: Symbol

type AttrOrigin SocketKeepalivePropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketKeepalivePropertyInfo

type AttrOrigin SocketKeepalivePropertyInfo = Socket

type AttrLabel SocketKeepalivePropertyInfo

type AttrLabel SocketKeepalivePropertyInfo = "keepalive"

type AttrGetType SocketKeepalivePropertyInfo

type AttrGetType SocketKeepalivePropertyInfo = Bool

type AttrBaseTypeConstraint SocketKeepalivePropertyInfo

type AttrBaseTypeConstraint SocketKeepalivePropertyInfo = IsSocket

type AttrSetTypeConstraint SocketKeepalivePropertyInfo

type AttrSetTypeConstraint SocketKeepalivePropertyInfo = * ~ Bool

type AttrAllowedOps SocketKeepalivePropertyInfo

type AttrAllowedOps SocketKeepalivePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketKeepalive :: IsSocket o => Bool -> IO (GValueConstruct o)

getSocketKeepalive :: (MonadIO m, IsSocket o) => o -> m Bool

setSocketKeepalive :: (MonadIO m, IsSocket o) => o -> Bool -> m ()

socketKeepalive :: AttrLabelProxy "keepalive"

listenBacklog

data SocketListenBacklogPropertyInfo

Instances

AttrInfo SocketListenBacklogPropertyInfo

Associated Types

type AttrAllowedOps SocketListenBacklogPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketListenBacklogPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketListenBacklogPropertyInfo :: * -> Constraint

type AttrGetType SocketListenBacklogPropertyInfo :: *

type AttrLabel SocketListenBacklogPropertyInfo :: Symbol

type AttrOrigin SocketListenBacklogPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketListenBacklogPropertyInfo

type AttrOrigin SocketListenBacklogPropertyInfo = Socket

type AttrLabel SocketListenBacklogPropertyInfo

type AttrLabel SocketListenBacklogPropertyInfo = "listen-backlog"

type AttrGetType SocketListenBacklogPropertyInfo

type AttrGetType SocketListenBacklogPropertyInfo = Int32

type AttrBaseTypeConstraint SocketListenBacklogPropertyInfo

type AttrBaseTypeConstraint SocketListenBacklogPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketListenBacklogPropertyInfo

type AttrSetTypeConstraint SocketListenBacklogPropertyInfo = * ~ Int32

type AttrAllowedOps SocketListenBacklogPropertyInfo

type AttrAllowedOps SocketListenBacklogPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketListenBacklog :: IsSocket o => Int32 -> IO (GValueConstruct o)

getSocketListenBacklog :: (MonadIO m, IsSocket o) => o -> m Int32

setSocketListenBacklog :: (MonadIO m, IsSocket o) => o -> Int32 -> m ()

socketListenBacklog :: AttrLabelProxy "listenBacklog"

localAddress

data SocketLocalAddressPropertyInfo

Instances

AttrInfo SocketLocalAddressPropertyInfo

Associated Types

type AttrAllowedOps SocketLocalAddressPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketLocalAddressPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketLocalAddressPropertyInfo :: * -> Constraint

type AttrGetType SocketLocalAddressPropertyInfo :: *

type AttrLabel SocketLocalAddressPropertyInfo :: Symbol

type AttrOrigin SocketLocalAddressPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketLocalAddressPropertyInfo

type AttrOrigin SocketLocalAddressPropertyInfo = Socket

type AttrLabel SocketLocalAddressPropertyInfo

type AttrLabel SocketLocalAddressPropertyInfo = "local-address"

type AttrGetType SocketLocalAddressPropertyInfo

type AttrGetType SocketLocalAddressPropertyInfo = Maybe SocketAddress

type AttrBaseTypeConstraint SocketLocalAddressPropertyInfo

type AttrBaseTypeConstraint SocketLocalAddressPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketLocalAddressPropertyInfo

type AttrSetTypeConstraint SocketLocalAddressPropertyInfo = * ~ ()

type AttrAllowedOps SocketLocalAddressPropertyInfo

type AttrAllowedOps SocketLocalAddressPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getSocketLocalAddress :: (MonadIO m, IsSocket o) => o -> m (Maybe SocketAddress)

socketLocalAddress :: AttrLabelProxy "localAddress"

multicastLoopback

data SocketMulticastLoopbackPropertyInfo

Instances

AttrInfo SocketMulticastLoopbackPropertyInfo

Associated Types

type AttrAllowedOps SocketMulticastLoopbackPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketMulticastLoopbackPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketMulticastLoopbackPropertyInfo :: * -> Constraint

type AttrGetType SocketMulticastLoopbackPropertyInfo :: *

type AttrLabel SocketMulticastLoopbackPropertyInfo :: Symbol

type AttrOrigin SocketMulticastLoopbackPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketMulticastLoopbackPropertyInfo

type AttrOrigin SocketMulticastLoopbackPropertyInfo = Socket

type AttrLabel SocketMulticastLoopbackPropertyInfo

type AttrLabel SocketMulticastLoopbackPropertyInfo = "multicast-loopback"

type AttrGetType SocketMulticastLoopbackPropertyInfo

type AttrGetType SocketMulticastLoopbackPropertyInfo = Bool

type AttrBaseTypeConstraint SocketMulticastLoopbackPropertyInfo

type AttrBaseTypeConstraint SocketMulticastLoopbackPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketMulticastLoopbackPropertyInfo

type AttrSetTypeConstraint SocketMulticastLoopbackPropertyInfo = * ~ Bool

type AttrAllowedOps SocketMulticastLoopbackPropertyInfo

type AttrAllowedOps SocketMulticastLoopbackPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketMulticastLoopback :: IsSocket o => Bool -> IO (GValueConstruct o)

getSocketMulticastLoopback :: (MonadIO m, IsSocket o) => o -> m Bool

setSocketMulticastLoopback :: (MonadIO m, IsSocket o) => o -> Bool -> m ()

socketMulticastLoopback :: AttrLabelProxy "multicastLoopback"

multicastTtl

data SocketMulticastTtlPropertyInfo

Instances

AttrInfo SocketMulticastTtlPropertyInfo

Associated Types

type AttrAllowedOps SocketMulticastTtlPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketMulticastTtlPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketMulticastTtlPropertyInfo :: * -> Constraint

type AttrGetType SocketMulticastTtlPropertyInfo :: *

type AttrLabel SocketMulticastTtlPropertyInfo :: Symbol

type AttrOrigin SocketMulticastTtlPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketMulticastTtlPropertyInfo

type AttrOrigin SocketMulticastTtlPropertyInfo = Socket

type AttrLabel SocketMulticastTtlPropertyInfo

type AttrLabel SocketMulticastTtlPropertyInfo = "multicast-ttl"

type AttrGetType SocketMulticastTtlPropertyInfo

type AttrGetType SocketMulticastTtlPropertyInfo = Word32

type AttrBaseTypeConstraint SocketMulticastTtlPropertyInfo

type AttrBaseTypeConstraint SocketMulticastTtlPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketMulticastTtlPropertyInfo

type AttrSetTypeConstraint SocketMulticastTtlPropertyInfo = * ~ Word32

type AttrAllowedOps SocketMulticastTtlPropertyInfo

type AttrAllowedOps SocketMulticastTtlPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketMulticastTtl :: IsSocket o => Word32 -> IO (GValueConstruct o)

getSocketMulticastTtl :: (MonadIO m, IsSocket o) => o -> m Word32

setSocketMulticastTtl :: (MonadIO m, IsSocket o) => o -> Word32 -> m ()

socketMulticastTtl :: AttrLabelProxy "multicastTtl"

protocol

data SocketProtocolPropertyInfo

Instances

AttrInfo SocketProtocolPropertyInfo

Associated Types

type AttrAllowedOps SocketProtocolPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketProtocolPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketProtocolPropertyInfo :: * -> Constraint

type AttrGetType SocketProtocolPropertyInfo :: *

type AttrLabel SocketProtocolPropertyInfo :: Symbol

type AttrOrigin SocketProtocolPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketProtocolPropertyInfo

type AttrOrigin SocketProtocolPropertyInfo = Socket

type AttrLabel SocketProtocolPropertyInfo

type AttrLabel SocketProtocolPropertyInfo = "protocol"

type AttrGetType SocketProtocolPropertyInfo

type AttrGetType SocketProtocolPropertyInfo = SocketProtocol

type AttrBaseTypeConstraint SocketProtocolPropertyInfo

type AttrBaseTypeConstraint SocketProtocolPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketProtocolPropertyInfo

type AttrSetTypeConstraint SocketProtocolPropertyInfo = * ~ SocketProtocol

type AttrAllowedOps SocketProtocolPropertyInfo

type AttrAllowedOps SocketProtocolPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructSocketProtocol :: IsSocket o => SocketProtocol -> IO (GValueConstruct o)

getSocketProtocol :: (MonadIO m, IsSocket o) => o -> m SocketProtocol

socketProtocol :: AttrLabelProxy "protocol"

remoteAddress

data SocketRemoteAddressPropertyInfo

Instances

AttrInfo SocketRemoteAddressPropertyInfo

Associated Types

type AttrAllowedOps SocketRemoteAddressPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketRemoteAddressPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketRemoteAddressPropertyInfo :: * -> Constraint

type AttrGetType SocketRemoteAddressPropertyInfo :: *

type AttrLabel SocketRemoteAddressPropertyInfo :: Symbol

type AttrOrigin SocketRemoteAddressPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketRemoteAddressPropertyInfo

type AttrOrigin SocketRemoteAddressPropertyInfo = Socket

type AttrLabel SocketRemoteAddressPropertyInfo

type AttrLabel SocketRemoteAddressPropertyInfo = "remote-address"

type AttrGetType SocketRemoteAddressPropertyInfo

type AttrGetType SocketRemoteAddressPropertyInfo = Maybe SocketAddress

type AttrBaseTypeConstraint SocketRemoteAddressPropertyInfo

type AttrBaseTypeConstraint SocketRemoteAddressPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketRemoteAddressPropertyInfo

type AttrSetTypeConstraint SocketRemoteAddressPropertyInfo = * ~ ()

type AttrAllowedOps SocketRemoteAddressPropertyInfo

type AttrAllowedOps SocketRemoteAddressPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

getSocketRemoteAddress :: (MonadIO m, IsSocket o) => o -> m (Maybe SocketAddress)

socketRemoteAddress :: AttrLabelProxy "remoteAddress"

timeout

data SocketTimeoutPropertyInfo

Instances

AttrInfo SocketTimeoutPropertyInfo

Associated Types

type AttrAllowedOps SocketTimeoutPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketTimeoutPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketTimeoutPropertyInfo :: * -> Constraint

type AttrGetType SocketTimeoutPropertyInfo :: *

type AttrLabel SocketTimeoutPropertyInfo :: Symbol

type AttrOrigin SocketTimeoutPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketTimeoutPropertyInfo

type AttrOrigin SocketTimeoutPropertyInfo = Socket

type AttrLabel SocketTimeoutPropertyInfo

type AttrLabel SocketTimeoutPropertyInfo = "timeout"

type AttrGetType SocketTimeoutPropertyInfo

type AttrGetType SocketTimeoutPropertyInfo = Word32

type AttrBaseTypeConstraint SocketTimeoutPropertyInfo

type AttrBaseTypeConstraint SocketTimeoutPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketTimeoutPropertyInfo

type AttrSetTypeConstraint SocketTimeoutPropertyInfo = * ~ Word32

type AttrAllowedOps SocketTimeoutPropertyInfo

type AttrAllowedOps SocketTimeoutPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketTimeout :: IsSocket o => Word32 -> IO (GValueConstruct o)

getSocketTimeout :: (MonadIO m, IsSocket o) => o -> m Word32

setSocketTimeout :: (MonadIO m, IsSocket o) => o -> Word32 -> m ()

socketTimeout :: AttrLabelProxy "timeout"

ttl

data SocketTtlPropertyInfo

Instances

AttrInfo SocketTtlPropertyInfo

Associated Types

type AttrAllowedOps SocketTtlPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketTtlPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketTtlPropertyInfo :: * -> Constraint

type AttrGetType SocketTtlPropertyInfo :: *

type AttrLabel SocketTtlPropertyInfo :: Symbol

type AttrOrigin SocketTtlPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketTtlPropertyInfo

type AttrOrigin SocketTtlPropertyInfo = Socket

type AttrLabel SocketTtlPropertyInfo

type AttrLabel SocketTtlPropertyInfo = "ttl"

type AttrGetType SocketTtlPropertyInfo

type AttrGetType SocketTtlPropertyInfo = Word32

type AttrBaseTypeConstraint SocketTtlPropertyInfo

type AttrBaseTypeConstraint SocketTtlPropertyInfo = IsSocket

type AttrSetTypeConstraint SocketTtlPropertyInfo

type AttrSetTypeConstraint SocketTtlPropertyInfo = * ~ Word32

type AttrAllowedOps SocketTtlPropertyInfo

type AttrAllowedOps SocketTtlPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructSocketTtl :: IsSocket o => Word32 -> IO (GValueConstruct o)

getSocketTtl :: (MonadIO m, IsSocket o) => o -> m Word32

setSocketTtl :: (MonadIO m, IsSocket o) => o -> Word32 -> m ()

socketTtl :: AttrLabelProxy "ttl"

type

data SocketTypePropertyInfo

Instances

AttrInfo SocketTypePropertyInfo

Associated Types

type AttrAllowedOps SocketTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint SocketTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint SocketTypePropertyInfo :: * -> Constraint

type AttrGetType SocketTypePropertyInfo :: *

type AttrLabel SocketTypePropertyInfo :: Symbol

type AttrOrigin SocketTypePropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin SocketTypePropertyInfo

type AttrOrigin SocketTypePropertyInfo = Socket

type AttrLabel SocketTypePropertyInfo

type AttrLabel SocketTypePropertyInfo = "type"

type AttrGetType SocketTypePropertyInfo

type AttrGetType SocketTypePropertyInfo = SocketType

type AttrBaseTypeConstraint SocketTypePropertyInfo

type AttrBaseTypeConstraint SocketTypePropertyInfo = IsSocket

type AttrSetTypeConstraint SocketTypePropertyInfo

type AttrSetTypeConstraint SocketTypePropertyInfo = * ~ SocketType

type AttrAllowedOps SocketTypePropertyInfo

type AttrAllowedOps SocketTypePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructSocketType :: IsSocket o => SocketType -> IO (GValueConstruct o)

getSocketType :: (MonadIO m, IsSocket o) => o -> m SocketType

socketType :: AttrLabelProxy "type"