circlet

Type Members

1. type Cont = (Option[Response]) ⇒ Sent.type

   

2. type Handler = (Request) ⇒ (Cont) ⇒ Sent.type

   

3. sealed trait HttpMethod extends AnyRef

   

4. case class JettyOptions(join: Boolean = true, host: Option[String] = None, httpPort: Int = 80, maxThreads: Int = 50, minThreads: Int = 8, daemonThreads: Boolean = false, configFn: (Server) ⇒ Unit = _ =>, maxIdleTime: Int = 200000, allowHttp: Boolean = true, allowSsl: Boolean = false, sslPort: Int = 443, sendDateHeader: Boolean = true, outputBufferSize: Int = 32768, requestHeaderSize: Int = 8192, responseHeaderSize: Int = 8192, sendServerVersion: Boolean = true, keyStore: Option[SslStoreConfig] = None, keyStorePassword: Option[String] = None, trustStore: Option[SslStoreConfig] = None, trustStorePassword: Option[String] = None, clientAuth: Option[ClientAuth] = None, excludeCiphers: Vector[String] = Vector.empty, excludeProtocols: Vector[String] = Vector.empty) extends Product with Serializable

   

   Options for configuring Jetty.

   Options for configuring Jetty.

   join

   If true, calls join() on Server instance (blocking till server shuts down)

   host

   The network interface connectors will bind to. If None or 0.0.0.0, binds to all interfaces.

   httpPort

   A ServerConnector will be created listening on this port.

   maxThreads

   Max threads in the threadpool used by connectors to run (eventually) the handler.

   minThreads

   Minimum threads to keep alive in the Jetty threadpool.

   daemonThreads

   If true, all threads in Jetty's threadpool will be daemon threads.

   configFn

   A function to mess around with the Server instance before start is called.

   maxIdleTime

   The max idle time for a connection (roughly Socket.setSoTimeout(int))

   allowHttp

   If true an HTTP connector is setup listening on port

   allowSsl

   If true an SSL connector is setup listing on sslPort

   sslPort

   The port to listen for SSL connections if enableSsl is true.

   sendDateHeader

   If true, include date in HTTP headers

   outputBufferSize

   The size of the buffer into which the response is aggregated before being sent to the client. Larger buffer is less likely to block content producer, but could increase from client's perspective.

   requestHeaderSize

   Max size of a request header. Larger sizes allow for more cookies or stuff encoded in a URL.

   responseHeaderSize

   Max size of a response header. Similar use cases as requestHeaderSize.

   sendServerVersion

   If true, send the Server header in responses.

   keyStore

   Specifies the keystore (private certs) to use for SSL connections

   keyStorePassword

   Password for keystore

   trustStore

   Specifies the keystore (public certs) to use for SSL connections

   trustStorePassword

   Password for trustStore

   clientAuth

   Policy for client SSL authentication (i.e. Need/Want).

   excludeCiphers

   Cipher suites to exclude when using SSL

   excludeProtocols

   Protocols to exclude when using SSL

5. type Middleware = (Handler) ⇒ Handler

   

6. case class Request(serverPort: Int, serverName: String, remoteAddr: String, uri: String, queryString: Option[String] = None, scheme: Scheme = Scheme.Http, requestMethod: HttpMethod = HttpMethod.Get, protocol: String = "HTTP/1.1", sslClientCert: Option[X509Certificate] = None, headers: Map[String, String] = Map.empty, body: Option[InputStream] = None, attrs: Map[String, AnyRef] = Map.empty) extends Product with Serializable

   

   Basic request.

   Basic request. Modeled after Request Map in https://github.com/ring-clojure/ring/blob/master/SPEC

   serverPort

   The port on which the request is being handled.

   serverName

   The resolved server name, or the server IP address.

   remoteAddr

   The IP address of the client or the last proxy that sent the request.

   uri

   The request URI, excluding the query string and the "?" separator. Must start with "/".

   queryString

   The query string, if present.

   scheme

   The transport protocol.

   requestMethod

   The transport protocol.

   protocol

   The protocol the request was made with, e.g. "HTTP/1.1"

   sslClientCert

   The SSL client certificate, if supplied.

   headers

   A map of lowercased header names to corresponding values.

   body

   The request body, if present.

   attrs

   Other info tacked on to the request.

7. case class Response(status: Int = 200, headers: Map[String, Vector[String]] = Map.empty, body: Option[ResponseBody] = None, attrs: Map[String, AnyRef] = Map.empty) extends Product with Serializable

   

   Basic response.

   Basic response. Modeled after Response Map in https://github.com/ring-clojure/ring/blob/master/SPEC

   status

   The HTTP status code, must be greater than or equal to 100.

   headers

   A map of HTTP header names to header values. These values may be either Strings, in which case one name/value header will be sent in the HTTP response, or a seq of Strings, in which case a name/value header will be sent for each such String value.

   body

   A representation of the response body, if a response body is appropriate for the response's status code.

   attrs

   Extra key/value data attached the the response.

8. sealed trait ResponseBody extends AnyRef

   

9. sealed trait Scheme extends AnyRef