GI.Gio.Objects.TcpConnection

This is the subclass of SocketConnection that is created for TCP/IP sockets.

Since: 2.22

Exported types

newtype TcpConnection

Memory-managed wrapper type.

Constructors

TcpConnection (ManagedPtr TcpConnection)

Instances

Eq TcpConnection

Defined in GI.Gio.Objects.TcpConnection

Methods

(==) :: TcpConnection -> TcpConnection -> Bool

(/=) :: TcpConnection -> TcpConnection -> Bool

IsGValue TcpConnection

Convert TcpConnection to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.TcpConnection

Methods

toGValue :: TcpConnection -> IO GValue

fromGValue :: GValue -> IO TcpConnection

ManagedPtrNewtype TcpConnection

Defined in GI.Gio.Objects.TcpConnection

Methods

toManagedPtr :: TcpConnection -> ManagedPtr TcpConnection

TypedObject TcpConnection

Defined in GI.Gio.Objects.TcpConnection

Methods

glibType :: IO GType

GObject TcpConnection

Defined in GI.Gio.Objects.TcpConnection

HasParentTypes TcpConnection

Defined in GI.Gio.Objects.TcpConnection

type ParentTypes TcpConnection

Defined in GI.Gio.Objects.TcpConnection

type ParentTypes TcpConnection = '[SocketConnection, IOStream, Object]

class (GObject o, IsDescendantOf TcpConnection o) => IsTcpConnection o

Type class for types which can be safely cast to TcpConnection, for instance with toTcpConnection.

Instances

(GObject o, IsDescendantOf TcpConnection o) => IsTcpConnection o

Defined in GI.Gio.Objects.TcpConnection

toTcpConnection :: (MonadIO m, IsTcpConnection o) => o -> m TcpConnection

Cast to TcpConnection, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getGracefulDisconnect

tcpConnectionGetGracefulDisconnect

Arguments

:: (HasCallStack, MonadIO m, IsTcpConnection a)

=> a

connection: a TcpConnection

-> m Bool

Returns: True if graceful disconnect is used on close, False otherwise

Checks if graceful disconnects are used. See tcpConnectionSetGracefulDisconnect.

Since: 2.22

setGracefulDisconnect

tcpConnectionSetGracefulDisconnect

Arguments

:: (HasCallStack, MonadIO m, IsTcpConnection a)

=> a

connection: a TcpConnection

-> Bool

gracefulDisconnect: Whether to do graceful disconnects or not

-> m ()

This enables graceful disconnects on close. A graceful disconnect means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection.

A graceful disconnect means that we can be sure that we successfully sent all the outstanding data to the other end, or get an error reported. However, it also means we have to wait for all the data to reach the other side and for it to acknowledge this by closing the socket, which may take a while. For this reason it is disabled by default.

Since: 2.22

Properties

gracefulDisconnect

No description available in the introspection data.

constructTcpConnectionGracefulDisconnect :: (IsTcpConnection o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “graceful-disconnect” property. This is rarely needed directly, but it is used by new.

getTcpConnectionGracefulDisconnect :: (MonadIO m, IsTcpConnection o) => o -> m Bool

Get the value of the “graceful-disconnect” property. When overloading is enabled, this is equivalent to

get tcpConnection #gracefulDisconnect

setTcpConnectionGracefulDisconnect :: (MonadIO m, IsTcpConnection o) => o -> Bool -> m ()

Set the value of the “graceful-disconnect” property. When overloading is enabled, this is equivalent to

set tcpConnection [ #gracefulDisconnect := value ]