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 (ForeignPtr 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
((~) (TYPE Lifted) signature (m IOStream), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextStealConnectionMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextStealConnectionMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m Socket), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetSocketMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetSocketMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m SocketAddress), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetRemoteAddressMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetRemoteAddressMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m SocketAddress), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetLocalAddressMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetLocalAddressMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetHostMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetHostMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m Socket), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetGsocketMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetGsocketMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m Text), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetAuthUserMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetAuthUserMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m AuthDomain), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetAuthDomainMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetAuthDomainMethodInfo ClientContext -> signature -> s
((~) (TYPE Lifted) signature (m Address), MonadIO m) => MethodInfo (TYPE Lifted) ClientContextGetAddressMethodInfo ClientContext signature Source
Methods overloadedMethod :: MethodProxy ClientContextGetAddressMethodInfo ClientContext -> signature -> s

noClientContext :: Maybe ClientContext Source

Methods

clientContextGetAddress

data ClientContextGetAddressMethodInfo Source

Instances

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

clientContextGetAddress :: MonadIO m => ClientContext -> m Address Source

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

clientContextGetAuthDomain

data ClientContextGetAuthDomainMethodInfo Source

Instances

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

clientContextGetAuthDomain :: MonadIO m => ClientContext -> m AuthDomain Source

clientContextGetAuthUser

data ClientContextGetAuthUserMethodInfo Source

Instances

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

clientContextGetAuthUser :: MonadIO m => ClientContext -> m Text Source

clientContextGetGsocket

data ClientContextGetGsocketMethodInfo Source

Instances

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

clientContextGetGsocket :: MonadIO m => ClientContext -> m Socket Source

clientContextGetHost

data ClientContextGetHostMethodInfo Source

Instances

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

clientContextGetHost :: MonadIO m => ClientContext -> m Text Source

clientContextGetLocalAddress

data ClientContextGetLocalAddressMethodInfo Source

Instances

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

clientContextGetLocalAddress :: MonadIO m => ClientContext -> m SocketAddress Source

clientContextGetRemoteAddress

data ClientContextGetRemoteAddressMethodInfo Source

Instances

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

clientContextGetRemoteAddress :: MonadIO m => ClientContext -> m SocketAddress Source

clientContextGetSocket

data ClientContextGetSocketMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Socket), MonadIO m) => MethodInfo (TYPE Lifted) 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.

clientContextStealConnection

data ClientContextStealConnectionMethodInfo Source

Instances

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

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