p

zio

http

package http

Linear Supertypes
RouteDecoderModule, RequestSyntax, PathSyntax, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. http
  2. RouteDecoderModule
  3. RequestSyntax
  4. PathSyntax
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package codec
  2. package endpoint
  3. package forms
  4. package html
  5. package internal
  6. package middleware
  7. package model
  8. package netty
  9. package socket

Type Members

  1. type App[-R] = Http[R, Response, Request, Response]
  2. trait Body extends AnyRef

    Holds Body that needs to be written on the HttpChannel

  3. trait Channel[-A] extends AnyRef

    An immutable and type-safe representation of one or more netty channels.

    An immutable and type-safe representation of one or more netty channels. A represents the type of messages that can be written on the channel.

  4. final case class ChannelEvent[-A, +B](channel: Channel[A], event: Event[B]) extends Product with Serializable

    Immutable and type-safe representation of events that are triggered on a netty channel.

    Immutable and type-safe representation of events that are triggered on a netty channel. A represents the inbound message type and B represents the outbound message type that's allowed on the channel.

  5. type Client = ZClient[Any, Body, Throwable, Response]
  6. case class ClientConfig(socketApp: Option[SocketApp[Any]] = None, ssl: Option[ClientSSLConfig] = None, proxy: Option[Proxy] = None, channelType: ChannelType = ChannelType.AUTO, nThreads: Int = 0, useAggregator: Boolean = true, connectionPool: ConnectionPoolConfig = ConnectionPoolConfig.Disabled, maxHeaderSize: Int = 8192, requestDecompression: Decompression = Decompression.No, localAddress: Option[InetSocketAddress] = None) extends http.netty.EventLoopGroups.Config with Product with Serializable
  7. trait ClientDriver extends AnyRef
  8. sealed trait ClientSSLConfig extends AnyRef
  9. trait ComposeLowPriorityImplicits extends AnyRef
  10. trait ConnectionPool[Connection] extends AnyRef
  11. sealed trait ConnectionPoolConfig extends AnyRef
  12. sealed trait CookieDecoder[A] extends AnyRef
  13. sealed trait CookieEncoder[A] extends AnyRef
  14. sealed trait Decompression extends AnyRef
  15. trait Driver extends AnyRef
  16. type EHttpApp = Http[Any, Throwable, Request, Response]
  17. trait Extractor extends AnyRef

    Path is an immutable representation of a urls path.

    Path is an immutable representation of a urls path. Internally it stores each element of a path in a sequence of Segment. This allows for powerful compositional APIs.

  18. sealed trait Handler[-R, +Err, -In, +Out] extends AnyRef
  19. type HandlerAspect[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
  20. sealed trait Http[-R, +Err, -In, +Out] extends AnyRef
  21. type HttpApp[-R, +Err] = Http[R, Err, Request, Response]
  22. type HttpAppMiddleware[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
  23. case class IntExtractor(int: Int) extends Extractor with Product with Serializable
  24. sealed trait Patch extends AnyRef

    Models the set of operations that one would want to apply on a Response.

  25. final case class Path extends Product with Serializable
  26. final case class Proxy(url: URL, credentials: Option[Credentials] = None, headers: Headers = Headers.empty) extends Product with Serializable

    Represents the connection to the forward proxy before running the request

  27. final case class QueryParams extends Map[String, Chunk[String]] with Product with Serializable
  28. type RHttpApp[-R] = Http[R, Throwable, Request, Response]
  29. final case class Request(body: Body, headers: Headers, method: Method, url: URL, version: Version, remoteAddress: Option[InetAddress]) extends HeaderExtension[Request] with Product with Serializable
  30. type RequestHandler[-R, +Err] = Handler[R, Err, Request, Response]
  31. type RequestHandlerMiddleware[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
  32. sealed trait Response extends HeaderExtension[Response]
  33. trait RouteDecoderModule extends AnyRef

    Instead of using just String as path params, using the RouteDecoderModule we can extract and converted params into a specific type also.

    Instead of using just String as path params, using the RouteDecoderModule we can extract and converted params into a specific type also.

    scala Http.collect[Request] { case GET -> !! / "user" / int(id) => Response.text("User id requested: ${id}") case GET -> !! / "user" / name => Response.text("User name requested: ${name}") }

    If the request looks like GET /user/100 then it would match the first case. This is because internally the id param can be decoded into an Int. If a request of the form GET /user/zio is made, in that case the second case is matched.

  34. abstract class RouteDecode[A] extends AnyRef
    Definition Classes
    RouteDecoderModule
  35. final case class SSLConfig(behaviour: HttpBehaviour, data: Data, provider: Provider) extends Product with Serializable
  36. trait Server extends AnyRef
  37. final case class ServerConfig(sslConfig: Option[SSLConfig] = None, address: InetSocketAddress = new InetSocketAddress(8080), acceptContinue: Boolean = false, keepAlive: Boolean = true, consolidateFlush: Boolean = false, flowControl: Boolean = true, requestDecompression: Decompression = Decompression.No, responseCompression: Option[ResponseCompressionConfig] = None, objectAggregator: Int = 1024 * 100, channelType: ChannelType = ChannelType.AUTO, nThreads: Int = 0, maxHeaderSize: Int = 8192) extends http.netty.EventLoopGroups.Config with Product with Serializable
  38. type UHttp[-A, +B] = Http[Any, Nothing, A, B]
  39. type UHttpApp = Http[Any, Nothing, Request, Response]
  40. final case class URL(path: Path, kind: Location = URL.Location.Relative, queryParams: QueryParams = QueryParams.empty, fragment: Option[Fragment] = None) extends Product with Serializable
  41. trait ZClient[-Env, -In, +Err, +Out] extends AnyRef
  42. trait ZClientAspect[+LowerEnv, -UpperEnv, +LowerIn, -UpperIn, +LowerErr, -UpperErr, +LowerOut, -UpperOut] extends AnyRef

    A ZClientAspect is capable on modifying some aspect of the execution of a client, such as metrics, tracing, encoding, decoding, or logging.

  43. trait ZCompose[+LeftLower, -LeftUpper, LeftOut[In], +RightLower, -RightUpper, RightOut[In]] extends AnyRef

Value Members

  1. val !!: Path
    Definition Classes
    PathSyntax
  2. def Client: ZClient.type
  3. val ~~: Path
    Definition Classes
    PathSyntax
  4. object ->
    Definition Classes
    RequestSyntax
  5. object /
    Definition Classes
    PathSyntax
  6. object /:
    Definition Classes
    PathSyntax
  7. object Body
  8. object ChannelEvent extends Serializable
  9. object ClientConfig extends Serializable
  10. object ClientDriver
  11. object ClientSSLConfig
  12. object ConnectionPoolConfig
  13. object CookieDecoder
  14. object CookieEncoder
  15. object Decompression
  16. object Driver
  17. object Handler
  18. object HandlerAspect
  19. object Http
  20. object HttpAppMiddleware extends RequestHandlerMiddlewares with HttpRoutesMiddlewares
  21. object Patch
  22. object Path extends Serializable
  23. object Proxy extends Serializable
  24. object QueryParams extends Serializable
  25. object Request extends Serializable
  26. object RequestHandlerMiddleware
  27. object Response
  28. object boolean extends RouteDecode[Boolean]
    Definition Classes
    RouteDecoderModule
  29. object byte extends RouteDecode[Byte]
    Definition Classes
    RouteDecoderModule
  30. object date extends RouteDecode[LocalDate]
    Definition Classes
    RouteDecoderModule
  31. object double extends RouteDecode[Double]
    Definition Classes
    RouteDecoderModule
  32. object float extends RouteDecode[Float]
    Definition Classes
    RouteDecoderModule
  33. object int extends RouteDecode[Int]
    Definition Classes
    RouteDecoderModule
  34. object long extends RouteDecode[Long]
    Definition Classes
    RouteDecoderModule
  35. object short extends RouteDecode[Short]
    Definition Classes
    RouteDecoderModule
  36. object time extends RouteDecode[LocalDateTime]
    Definition Classes
    RouteDecoderModule
  37. object uuid extends RouteDecode[UUID]
    Definition Classes
    RouteDecoderModule
  38. object SSLConfig extends Serializable
  39. object Server
  40. object ServerConfig extends Serializable
  41. object URL extends Serializable
  42. object ZClient
  43. object ZCompose extends ComposeLowPriorityImplicits

Inherited from RouteDecoderModule

Inherited from RequestSyntax

Inherited from PathSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped