Docker.Client.Http

Documentation

type Request = Request

type Response = Response ByteString

type HttpVerb = StdMethod

newtype HttpHandler m

Constructors

HttpHandler (forall a. Request -> (Response () -> Sink ByteString m (Either DockerError a)) -> m (Either DockerError a))

Instances

Monad m => MonadReader (DockerClientOpts, HttpHandler m) (DockerT m)

Methods

ask :: DockerT m (DockerClientOpts, HttpHandler m)

local :: ((DockerClientOpts, HttpHandler m) -> (DockerClientOpts, HttpHandler m)) -> DockerT m a -> DockerT m a

reader :: ((DockerClientOpts, HttpHandler m) -> a) -> DockerT m a

data DockerError

Constructors

DockerConnectionError HttpException

DockerInvalidRequest Endpoint

DockerClientError Text

DockerClientDecodeError Text

Could not parse the response from the Docker endpoint.

DockerInvalidStatusCode Status

Invalid exit code received from Docker endpoint.

GenericDockerError Text

Instances

Show DockerError

Methods

showsPrec :: Int -> DockerError -> ShowS

show :: DockerError -> String

showList :: [DockerError] -> ShowS

newtype DockerT m a

Constructors

DockerT

Fields

• unDockerT :: Monad m => ReaderT (DockerClientOpts, HttpHandler m) m a

Instances

MonadTrans DockerT

Methods

lift :: Monad m => m a -> DockerT m a

Monad m => Monad (DockerT m)

Methods

(>>=) :: DockerT m a -> (a -> DockerT m b) -> DockerT m b

(>>) :: DockerT m a -> DockerT m b -> DockerT m b

return :: a -> DockerT m a

fail :: String -> DockerT m a

Functor m => Functor (DockerT m)

Methods

fmap :: (a -> b) -> DockerT m a -> DockerT m b

(<$) :: a -> DockerT m b -> DockerT m a

Applicative m => Applicative (DockerT m)

Methods

pure :: a -> DockerT m a

(<*>) :: DockerT m (a -> b) -> DockerT m a -> DockerT m b

(*>) :: DockerT m a -> DockerT m b -> DockerT m b

(<*) :: DockerT m a -> DockerT m b -> DockerT m a

MonadIO m => MonadIO (DockerT m)

Methods

liftIO :: IO a -> DockerT m a

Monad m => MonadReader (DockerClientOpts, HttpHandler m) (DockerT m)

Methods

ask :: DockerT m (DockerClientOpts, HttpHandler m)

local :: ((DockerClientOpts, HttpHandler m) -> (DockerClientOpts, HttpHandler m)) -> DockerT m a -> DockerT m a

reader :: ((DockerClientOpts, HttpHandler m) -> a) -> DockerT m a

runDockerT :: Monad m => (DockerClientOpts, HttpHandler m) -> DockerT m a -> m a

mkHttpRequest :: HttpVerb -> Endpoint -> DockerClientOpts -> Maybe Request

defaultHttpHandler :: (MonadIO m, MonadMask m) => m (HttpHandler m)

httpHandler :: (MonadIO m, MonadMask m) => Manager -> HttpHandler m

unixHttpHandler

Arguments

:: (MonadIO m, MonadMask m)

=> FilePath

The socket to connect to

-> m (HttpHandler m)

Connect to a unix domain socket (the default docker socket is at /var/run/docker.sock)

Docker seems to ignore the hostname in requests sent over unix domain sockets (and the port obviously doesn't matter either)

clientParamsWithClientAuthentication :: HostName -> PortNumber -> FilePath -> FilePath -> IO (Either String ClientParams)

clientParamsSetCA :: ClientParams -> FilePath -> IO ClientParams

statusCodeToError :: Endpoint -> Status -> Maybe DockerError