package http
- Alphabetic
- By Inheritance
- http
- RouteDecoderModule
- RequestSyntax
- PathSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
Type Members
- type App[-R] = Http[R, Response, Request, Response]
- trait Body extends AnyRef
Holds Body that needs to be written on the HttpChannel
- 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. - 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 andB
represents the outbound message type that's allowed on the channel. - type Client = ZClient[Any, Body, Throwable, Response]
- 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
- trait ClientDriver extends AnyRef
- sealed trait ClientSSLConfig extends AnyRef
- trait ComposeLowPriorityImplicits extends AnyRef
- trait ConnectionPool[Connection] extends AnyRef
- sealed trait ConnectionPoolConfig extends AnyRef
- sealed trait CookieDecoder[A] extends AnyRef
- sealed trait CookieEncoder[A] extends AnyRef
- sealed trait Decompression extends AnyRef
- trait Driver extends AnyRef
- type EHttpApp = Http[Any, Throwable, Request, Response]
- 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. - sealed trait Handler[-R, +Err, -In, +Out] extends AnyRef
- type HandlerAspect[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
- sealed trait Http[-R, +Err, -In, +Out] extends AnyRef
- type HttpApp[-R, +Err] = Http[R, Err, Request, Response]
- type HttpAppMiddleware[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
- case class IntExtractor(int: Int) extends Extractor with Product with Serializable
- sealed trait Patch extends AnyRef
Models the set of operations that one would want to apply on a Response.
- final case class Path extends Product with Serializable
- 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
- final case class QueryParams extends Map[String, Chunk[String]] with Product with Serializable
- type RHttpApp[-R] = Http[R, Throwable, Request, Response]
- final case class Request(body: Body, headers: Headers, method: Method, url: URL, version: Version, remoteAddress: Option[InetAddress]) extends HeaderExtension[Request] with Product with Serializable
- type RequestHandler[-R, +Err] = Handler[R, Err, Request, Response]
- type RequestHandlerMiddleware[+LowerEnv, -UpperEnv, +LowerErr, -UpperErr] = Contextual[LowerEnv, UpperEnv, LowerErr, UpperErr] { ... /* 2 definitions in type refinement */ }
- sealed trait Response extends HeaderExtension[Response]
- 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 theid
param can be decoded into anInt
. If a request of the formGET /user/zio
is made, in that case the second case is matched. - abstract class RouteDecode[A] extends AnyRef
- Definition Classes
- RouteDecoderModule
- final case class SSLConfig(behaviour: HttpBehaviour, data: Data, provider: Provider) extends Product with Serializable
- trait Server extends AnyRef
- 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
- type UHttp[-A, +B] = Http[Any, Nothing, A, B]
- type UHttpApp = Http[Any, Nothing, Request, Response]
- final case class URL(path: Path, kind: Location = URL.Location.Relative, queryParams: QueryParams = QueryParams.empty, fragment: Option[Fragment] = None) extends Product with Serializable
- trait ZClient[-Env, -In, +Err, +Out] extends AnyRef
- 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. - trait ZCompose[+LeftLower, -LeftUpper, LeftOut[In], +RightLower, -RightUpper, RightOut[In]] extends AnyRef
Value Members
- val !!: Path
- Definition Classes
- PathSyntax
- def Client: ZClient.type
- val ~~: Path
- Definition Classes
- PathSyntax
- object ->
- Definition Classes
- RequestSyntax
- object /
- Definition Classes
- PathSyntax
- object /:
- Definition Classes
- PathSyntax
- object Body
- object ChannelEvent extends Serializable
- object ClientConfig extends Serializable
- object ClientDriver
- object ClientSSLConfig
- object ConnectionPoolConfig
- object CookieDecoder
- object CookieEncoder
- object Decompression
- object Driver
- object Handler
- object HandlerAspect
- object Http
- object HttpAppMiddleware extends RequestHandlerMiddlewares with HttpRoutesMiddlewares
- object Patch
- object Path extends Serializable
- object Proxy extends Serializable
- object QueryParams extends Serializable
- object Request extends Serializable
- object RequestHandlerMiddleware
- object Response
- object boolean extends RouteDecode[Boolean]
- Definition Classes
- RouteDecoderModule
- object byte extends RouteDecode[Byte]
- Definition Classes
- RouteDecoderModule
- object date extends RouteDecode[LocalDate]
- Definition Classes
- RouteDecoderModule
- object double extends RouteDecode[Double]
- Definition Classes
- RouteDecoderModule
- object float extends RouteDecode[Float]
- Definition Classes
- RouteDecoderModule
- object int extends RouteDecode[Int]
- Definition Classes
- RouteDecoderModule
- object long extends RouteDecode[Long]
- Definition Classes
- RouteDecoderModule
- object short extends RouteDecode[Short]
- Definition Classes
- RouteDecoderModule
- object time extends RouteDecode[LocalDateTime]
- Definition Classes
- RouteDecoderModule
- object uuid extends RouteDecode[UUID]
- Definition Classes
- RouteDecoderModule
- object SSLConfig extends Serializable
- object Server
- object ServerConfig extends Serializable
- object URL extends Serializable
- object ZClient
- object ZCompose extends ComposeLowPriorityImplicits