GI.Gio.Objects.TcpConnection

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

Exported types

newtype TcpConnection

Constructors

TcpConnection (ManagedPtr TcpConnection)

Instances

GObject TcpConnection

Methods

gobjectType :: TcpConnection -> IO GType

IsObject TcpConnection

IsTcpConnection TcpConnection

IsSocketConnection TcpConnection

IsIOStream TcpConnection

((~) * info (ResolveTcpConnectionMethod t TcpConnection), MethodInfo * info TcpConnection p) => IsLabel t (TcpConnection -> p)

Methods

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

((~) * info (ResolveTcpConnectionMethod t TcpConnection), MethodInfo * info TcpConnection p) => IsLabelProxy t (TcpConnection -> p)

Methods

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

HasAttributeList * TcpConnection

type AttributeList TcpConnection

type AttributeList TcpConnection

type SignalList TcpConnection

type SignalList TcpConnection

class GObject o => IsTcpConnection o

Instances

(GObject a, UnknownAncestorError Constraint TcpConnection a) => IsTcpConnection a

IsTcpConnection TcpConnection

IsTcpConnection TcpWrapperConnection

toTcpConnection :: IsTcpConnection o => o -> IO TcpConnection

noTcpConnection :: Maybe TcpConnection

Methods

getGracefulDisconnect

data TcpConnectionGetGracefulDisconnectMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsTcpConnection a) => MethodInfo * TcpConnectionGetGracefulDisconnectMethodInfo a signature

Methods

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

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

data TcpConnectionSetGracefulDisconnectMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsTcpConnection a) => MethodInfo * TcpConnectionSetGracefulDisconnectMethodInfo a signature

Methods

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

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

data TcpConnectionGracefulDisconnectPropertyInfo

Instances

AttrInfo TcpConnectionGracefulDisconnectPropertyInfo

Associated Types

type AttrAllowedOps TcpConnectionGracefulDisconnectPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo :: * -> Constraint

type AttrGetType TcpConnectionGracefulDisconnectPropertyInfo :: *

type AttrLabel TcpConnectionGracefulDisconnectPropertyInfo :: Symbol

type AttrOrigin TcpConnectionGracefulDisconnectPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin TcpConnectionGracefulDisconnectPropertyInfo

type AttrOrigin TcpConnectionGracefulDisconnectPropertyInfo = TcpConnection

type AttrLabel TcpConnectionGracefulDisconnectPropertyInfo

type AttrLabel TcpConnectionGracefulDisconnectPropertyInfo = "graceful-disconnect"

type AttrGetType TcpConnectionGracefulDisconnectPropertyInfo

type AttrGetType TcpConnectionGracefulDisconnectPropertyInfo = Bool

type AttrBaseTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo

type AttrBaseTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo = IsTcpConnection

type AttrSetTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo

type AttrSetTypeConstraint TcpConnectionGracefulDisconnectPropertyInfo = * ~ Bool

type AttrAllowedOps TcpConnectionGracefulDisconnectPropertyInfo

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

constructTcpConnectionGracefulDisconnect :: IsTcpConnection o => Bool -> IO (GValueConstruct o)

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

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

tcpConnectionGracefulDisconnect :: AttrLabelProxy "gracefulDisconnect"