GI.Soup.Objects.Socket

Exported types

newtype Socket

Constructors

Socket (ManagedPtr Socket)

Instances

GObject Socket

Methods

gobjectType :: Socket -> IO GType

IsInitable Socket

IsObject Socket

IsSocket Socket

class GObject o => IsSocket o

Instances

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

IsSocket Socket

toSocket :: (MonadIO m, IsSocket o) => o -> m Socket

noSocket :: Maybe Socket

Methods

connectAsync

socketConnectAsync

Arguments

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

=> a

sock: a client Socket (which must not already be connected)

-> Maybe b

cancellable: a Cancellable, or Nothing

-> SocketCallback

callback: callback to call after connecting

-> m ()

Begins asynchronously connecting to sock's remote address. The socket will call callback when it succeeds or fails (but not before returning from this function).

If cancellable is non-Nothing, it can be used to cancel the connection. callback will still be invoked in this case, with a status of StatusCancelled.

connectSync

socketConnectSync

Arguments

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

=> a

sock: a client Socket (which must not already be connected)

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m Word32

Returns: a success or failure code.

Attempt to synchronously connect sock to its remote address.

If cancellable is non-Nothing, it can be used to cancel the connection, in which case socketConnectSync will return StatusCancelled.

disconnect

socketDisconnect

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m ()

Disconnects sock. Any further read or write attempts on it will fail.

getFd

socketGetFd

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m Int32

Returns: sock's file descriptor.

Gets sock's underlying file descriptor.

Note that fiddling with the file descriptor may break the Socket.

getLocalAddress

socketGetLocalAddress

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m Address

Returns: the Address

Returns the Address corresponding to the local end of sock.

Calling this method on an unconnected socket is considered to be an error, and produces undefined results.

getRemoteAddress

socketGetRemoteAddress

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m Address

Returns: the Address

Returns the Address corresponding to the remote end of sock.

Calling this method on an unconnected socket is considered to be an error, and produces undefined results.

isConnected

socketIsConnected

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m Bool

Returns: True or False.

Tests if sock is connected to another host

isSsl

socketIsSsl

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a Socket

-> m Bool

Returns: True if sock has SSL credentials set

Tests if sock is doing (or has attempted to do) SSL.

listen

socketListen

Arguments

:: (HasCallStack, MonadIO m, IsSocket a)

=> a

sock: a server Socket (which must not already be connected or listening)

-> m Bool

Returns: whether or not sock is now listening.

Makes sock start listening on its local address. When connections come in, sock will emit Socket::new_connection.

read

socketRead

Arguments

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

=> a

sock: the socket

-> ByteString

buffer: buffer to read into

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m (SocketIOStatus, Word64)

Returns: a SocketIOStatus, as described above (or SocketIOStatusEof if the socket is no longer connected, or SocketIOStatusError on any other error, in which case error will also be set). (Can throw GError)

Attempts to read up to len bytes from sock into buffer. If some data is successfully read, socketRead will return SocketIOStatusOk, and *nread will contain the number of bytes actually read (which may be less than len).

If sock is non-blocking, and no data is available, the return value will be SocketIOStatusWouldBlock. In this case, the caller can connect to the Socket::readable signal to know when there is more data to read. (NB: You MUST read all available data off the socket first. Socket::readable is only emitted after socketRead returns SocketIOStatusWouldBlock, and it is only emitted once. See the documentation for Socket:non-blocking.)

readUntil

socketReadUntil

Arguments

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

=> a

sock: the socket

-> ByteString

buffer: buffer to read into

-> Ptr ()

boundary: boundary to read until

-> Word64

boundaryLen: length of boundary in bytes

-> Bool

gotBoundary: on return, whether or not the data in buffer ends with the boundary string

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m (SocketIOStatus, Word64)

Returns: as for socketRead (Can throw GError)

Like socketRead, but reads no further than the first occurrence of boundary. (If the boundary is found, it will be included in the returned data, and *gotBoundary will be set to True.) Any data after the boundary will returned in future reads.

socketReadUntil will almost always return fewer than len bytes: if the boundary is found, then it will only return the bytes up until the end of the boundary, and if the boundary is not found, then it will leave the last <literal>(boundary_len - 1)</literal> bytes in its internal buffer, in case they form the start of the boundary string. Thus, len normally needs to be at least 1 byte longer than boundaryLen if you want to make any progress at all.

startProxySsl

socketStartProxySsl

Arguments

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

=> a

sock: the socket

-> Text

sslHost: hostname of the SSL server

-> Maybe b

cancellable: a Cancellable

-> m Bool

Returns: success or failure

Starts using SSL on socket, expecting to find a host named sslHost.

startSsl

socketStartSsl

Arguments

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

=> a

sock: the socket

-> Maybe b

cancellable: a Cancellable

-> m Bool

Returns: success or failure

Starts using SSL on socket.

write

socketWrite

Arguments

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

=> a

sock: the socket

-> ByteString

buffer: data to write

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m (SocketIOStatus, Word64)

Returns: a SocketIOStatus, as described above (or SocketIOStatusEof or SocketIOStatusError. error will be set if the return value is SocketIOStatusError.) (Can throw GError)

Attempts to write len bytes from buffer to sock. If some data is successfully written, the return status will be SocketIOStatusOk, and *nwrote will contain the number of bytes actually written (which may be less than len).

If sock is non-blocking, and no data could be written right away, the return value will be SocketIOStatusWouldBlock. In this case, the caller can connect to the Socket::writable signal to know when more data can be written. (NB: Socket::writable is only emitted after socketWrite returns SocketIOStatusWouldBlock, and it is only emitted once. See the documentation for Socket:non-blocking.)

Properties

asyncContext

constructSocketAsyncContext :: IsSocket o => Ptr () -> IO (GValueConstruct o)

getSocketAsyncContext :: (MonadIO m, IsSocket o) => o -> m (Ptr ())

fd

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

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

gsocket

constructSocketGsocket :: (IsSocket o, IsSocket a) => a -> IO (GValueConstruct o)

iostream

constructSocketIostream :: (IsSocket o, IsIOStream a) => a -> IO (GValueConstruct o)

ipv6Only

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

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

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

isServer

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

localAddress

constructSocketLocalAddress :: (IsSocket o, IsAddress a) => a -> IO (GValueConstruct o)

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

nonBlocking

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

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

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

remoteAddress

constructSocketRemoteAddress :: (IsSocket o, IsAddress a) => a -> IO (GValueConstruct o)

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

sslCreds

constructSocketSslCreds :: IsSocket o => Ptr () -> IO (GValueConstruct o)

getSocketSslCreds :: (MonadIO m, IsSocket o) => o -> m (Ptr ())

setSocketSslCreds :: (MonadIO m, IsSocket o) => o -> Ptr () -> m ()

sslFallback

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

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

sslStrict

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

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

timeout

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

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

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

tlsCertificate

getSocketTlsCertificate :: (MonadIO m, IsSocket o) => o -> m (Maybe TlsCertificate)

tlsErrors

getSocketTlsErrors :: (MonadIO m, IsSocket o) => o -> m [TlsCertificateFlags]

trustedCertificate

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

useThreadContext

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

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

Signals

disconnected

type C_SocketDisconnectedCallback = Ptr () -> Ptr () -> IO ()

type SocketDisconnectedCallback = IO ()

afterSocketDisconnected :: (IsSocket a, MonadIO m) => a -> SocketDisconnectedCallback -> m SignalHandlerId

genClosure_SocketDisconnected :: SocketDisconnectedCallback -> IO Closure

mk_SocketDisconnectedCallback :: C_SocketDisconnectedCallback -> IO (FunPtr C_SocketDisconnectedCallback)

noSocketDisconnectedCallback :: Maybe SocketDisconnectedCallback

onSocketDisconnected :: (IsSocket a, MonadIO m) => a -> SocketDisconnectedCallback -> m SignalHandlerId

wrap_SocketDisconnectedCallback :: SocketDisconnectedCallback -> Ptr () -> Ptr () -> IO ()

event

type C_SocketEventCallback = Ptr () -> CUInt -> Ptr IOStream -> Ptr () -> IO ()

type SocketEventCallback = SocketClientEvent -> IOStream -> IO ()

afterSocketEvent :: (IsSocket a, MonadIO m) => a -> SocketEventCallback -> m SignalHandlerId

genClosure_SocketEvent :: SocketEventCallback -> IO Closure

mk_SocketEventCallback :: C_SocketEventCallback -> IO (FunPtr C_SocketEventCallback)

noSocketEventCallback :: Maybe SocketEventCallback

onSocketEvent :: (IsSocket a, MonadIO m) => a -> SocketEventCallback -> m SignalHandlerId

wrap_SocketEventCallback :: SocketEventCallback -> Ptr () -> CUInt -> Ptr IOStream -> Ptr () -> IO ()

newConnection

type C_SocketNewConnectionCallback = Ptr () -> Ptr Socket -> Ptr () -> IO ()

type SocketNewConnectionCallback = Socket -> IO ()

afterSocketNewConnection :: (IsSocket a, MonadIO m) => a -> SocketNewConnectionCallback -> m SignalHandlerId

genClosure_SocketNewConnection :: SocketNewConnectionCallback -> IO Closure

mk_SocketNewConnectionCallback :: C_SocketNewConnectionCallback -> IO (FunPtr C_SocketNewConnectionCallback)

noSocketNewConnectionCallback :: Maybe SocketNewConnectionCallback

onSocketNewConnection :: (IsSocket a, MonadIO m) => a -> SocketNewConnectionCallback -> m SignalHandlerId

wrap_SocketNewConnectionCallback :: SocketNewConnectionCallback -> Ptr () -> Ptr Socket -> Ptr () -> IO ()

readable

type C_SocketReadableCallback = Ptr () -> Ptr () -> IO ()

type SocketReadableCallback = IO ()

afterSocketReadable :: (IsSocket a, MonadIO m) => a -> SocketReadableCallback -> m SignalHandlerId

genClosure_SocketReadable :: SocketReadableCallback -> IO Closure

mk_SocketReadableCallback :: C_SocketReadableCallback -> IO (FunPtr C_SocketReadableCallback)

noSocketReadableCallback :: Maybe SocketReadableCallback

onSocketReadable :: (IsSocket a, MonadIO m) => a -> SocketReadableCallback -> m SignalHandlerId

wrap_SocketReadableCallback :: SocketReadableCallback -> Ptr () -> Ptr () -> IO ()

writable

type C_SocketWritableCallback = Ptr () -> Ptr () -> IO ()

type SocketWritableCallback = IO ()

afterSocketWritable :: (IsSocket a, MonadIO m) => a -> SocketWritableCallback -> m SignalHandlerId

genClosure_SocketWritable :: SocketWritableCallback -> IO Closure

mk_SocketWritableCallback :: C_SocketWritableCallback -> IO (FunPtr C_SocketWritableCallback)

noSocketWritableCallback :: Maybe SocketWritableCallback

onSocketWritable :: (IsSocket a, MonadIO m) => a -> SocketWritableCallback -> m SignalHandlerId

wrap_SocketWritableCallback :: SocketWritableCallback -> Ptr () -> Ptr () -> IO ()