Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Soup.Structs.ClientContext

Contents

Exported types
Methods

Description

A #SoupClientContext provides additional information about the client making a particular request. In particular, you can use soup_client_context_get_auth_domain() and soup_client_context_get_auth_user() to determine if HTTP authentication was used successfully.

soup_client_context_get_remote_address() and/or soup_client_context_get_host() can be used to get information for logging or debugging purposes. soup_client_context_get_gsocket() may also be of use in some situations (eg, tracking when multiple requests are made on the same connection).

Synopsis

Exported types

newtype ClientContext Source #

Constructors

ClientContext (ManagedPtr ClientContext)

Instances

BoxedObject ClientContext Source #
Methods boxedType :: ClientContext -> IO GType
((~) * info (ResolveClientContextMethod t ClientContext), MethodInfo * info ClientContext p) => IsLabel t (ClientContext -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> ClientContext -> p #
((~) * info (ResolveClientContextMethod t ClientContext), MethodInfo * info ClientContext p) => IsLabelProxy t (ClientContext -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> ClientContext -> p
HasAttributeList * ClientContext Source #

((~) * signature (m IOStream), MonadIO m) => MethodInfo * ClientContextStealConnectionMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextStealConnectionMethodInfo ClientContext -> signature -> s
((~) * signature (m Socket), MonadIO m) => MethodInfo * ClientContextGetSocketMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetSocketMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe SocketAddress)), MonadIO m) => MethodInfo * ClientContextGetRemoteAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetRemoteAddressMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe SocketAddress)), MonadIO m) => MethodInfo * ClientContextGetLocalAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetLocalAddressMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe Text)), MonadIO m) => MethodInfo * ClientContextGetHostMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetHostMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe Socket)), MonadIO m) => MethodInfo * ClientContextGetGsocketMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetGsocketMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe Text)), MonadIO m) => MethodInfo * ClientContextGetAuthUserMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAuthUserMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe AuthDomain)), MonadIO m) => MethodInfo * ClientContextGetAuthDomainMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAuthDomainMethodInfo ClientContext -> signature -> s
((~) * signature (m (Maybe Address)), MonadIO m) => MethodInfo * ClientContextGetAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAddressMethodInfo ClientContext -> signature -> s
type AttributeList ClientContext Source #
type AttributeList ClientContext

noClientContext :: Maybe ClientContext Source #

Methods

getAddress

data ClientContextGetAddressMethodInfo Source #

Instances

((~) * signature (m (Maybe Address)), MonadIO m) => MethodInfo * ClientContextGetAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAddressMethodInfo ClientContext -> signature -> s

clientContextGetAddress :: MonadIO m => ClientContext -> m (Maybe Address) Source #

Deprecated: Use soup_client_context_get_remote_address(), which returnsa #GSocketAddress.

getAuthDomain

data ClientContextGetAuthDomainMethodInfo Source #

Instances

((~) * signature (m (Maybe AuthDomain)), MonadIO m) => MethodInfo * ClientContextGetAuthDomainMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAuthDomainMethodInfo ClientContext -> signature -> s

clientContextGetAuthDomain :: MonadIO m => ClientContext -> m (Maybe AuthDomain) Source #

getAuthUser

data ClientContextGetAuthUserMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m) => MethodInfo * ClientContextGetAuthUserMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetAuthUserMethodInfo ClientContext -> signature -> s

clientContextGetAuthUser :: MonadIO m => ClientContext -> m (Maybe Text) Source #

getGsocket

data ClientContextGetGsocketMethodInfo Source #

Instances

((~) * signature (m (Maybe Socket)), MonadIO m) => MethodInfo * ClientContextGetGsocketMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetGsocketMethodInfo ClientContext -> signature -> s

clientContextGetGsocket :: MonadIO m => ClientContext -> m (Maybe Socket) Source #

getHost

data ClientContextGetHostMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m) => MethodInfo * ClientContextGetHostMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetHostMethodInfo ClientContext -> signature -> s

clientContextGetHost :: MonadIO m => ClientContext -> m (Maybe Text) Source #

getLocalAddress

data ClientContextGetLocalAddressMethodInfo Source #

Instances

((~) * signature (m (Maybe SocketAddress)), MonadIO m) => MethodInfo * ClientContextGetLocalAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetLocalAddressMethodInfo ClientContext -> signature -> s

clientContextGetLocalAddress :: MonadIO m => ClientContext -> m (Maybe SocketAddress) Source #

getRemoteAddress

data ClientContextGetRemoteAddressMethodInfo Source #

Instances

((~) * signature (m (Maybe SocketAddress)), MonadIO m) => MethodInfo * ClientContextGetRemoteAddressMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetRemoteAddressMethodInfo ClientContext -> signature -> s

clientContextGetRemoteAddress :: MonadIO m => ClientContext -> m (Maybe SocketAddress) Source #

getSocket

data ClientContextGetSocketMethodInfo Source #

Instances

((~) * signature (m Socket), MonadIO m) => MethodInfo * ClientContextGetSocketMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextGetSocketMethodInfo ClientContext -> signature -> s

clientContextGetSocket :: MonadIO m => ClientContext -> m Socket Source #

Deprecated: use soup_client_context_get_gsocket(), which returnsa #GSocket.

stealConnection

data ClientContextStealConnectionMethodInfo Source #

Instances

((~) * signature (m IOStream), MonadIO m) => MethodInfo * ClientContextStealConnectionMethodInfo ClientContext signature Source #
Methods overloadedMethod :: MethodProxy ClientContextStealConnectionMethodInfo ClientContext -> signature -> s

clientContextStealConnection :: MonadIO m => ClientContext -> m IOStream Source #