servant-0.18.1: A family of combinators for defining webservices APIs
Safe HaskellSafe-Inferred
LanguageHaskell2010

Servant.API.RemoteHost

Synopsis

Documentation

Use RemoteHost whenever your request handlers need the host or IP address from which the client issued the HTTP request. The corresponding handlers receive arguments of type SockAddr (from Network.Socket).

Example:

>>> -- POST /record-ip
>>> type API = "record-ip" :> RemoteHost :> Post '[] ()

data RemoteHost Source #

Provides access to the host or IP address from which the HTTP request was sent.

Instances

Instances details
HasLink sub => HasLink (RemoteHost :> sub :: Type) Source # 
Instance details

Defined in Servant.Links

Associated Types

type MkLink (RemoteHost :> sub) a Source #

Methods

toLink :: (Link -> a) -> Proxy (RemoteHost :> sub) -> Link -> MkLink (RemoteHost :> sub) a Source #

type MkLink (RemoteHost :> sub :: Type) a Source # 
Instance details

Defined in Servant.Links

type MkLink (RemoteHost :> sub :: Type) a = MkLink sub a