< Back

Packages

package root

Definition Classes
root
package lol
This is the documentation for the lolhttp library.
This is the documentation for the lolhttp library.
- http is the core module providing HTTP Client and Server.
- json is an optional module providing integration with the circe JSON library.
- html is an optional module providing HTML templating.
Definition Classes
root
package http
The core module for lolhttp.
The core module for lolhttp.
```
Server.listen(8888) { request =>
  Ok("Hello world!")
}

Client.run(Get("http://localhost:8888/")) { response =>
  response.readAs[String]
}
```
Provides an HTTP Client and an HTTP Server. Both client and server are Service functions. A service function takes a Request and eventually returns a Response. Requests and responses are shared between the client and the server API, making it easy to assemble them. Both are seen as a set of HTTP headers, and a Content body.
The content Stream is based on fs2 and can be lazily consumed if needed. It can be encoded and decoded using the appropriate ContentEncoder and ContentDecoder.
SSL is supported on both sides.
Definition Classes
lol
ClasspathResource
Client
ClientOptions
Content
ContentDecoder
ContentEncoder
Error
Headers
HttpMethod
HttpString
LiteralHttpString
Panic
Request
Response
SSL
Server
ServerOptions
ServerSentEvents
UrlMatcher
at

c

ServerOptions

case class ServerOptions(ioThreads: Int = ..., tcpNoDelay: Boolean = true, bufferSize: Option[Int] = None, protocols: Set[String] = Set(HTTP), debug: Option[String] = None) extends Product with Serializable

Allow to configure an HTTP server.

ioThreads: the number of threads used for the IO work. Default to max(availableProcessors, 2).
tcpNoDelay: if true disable Nagle's algorithm. Default true.
bufferSize: if defined used as a hint for the TCP buffer size. If none use the system default. Default to None.
protocols: the allowed protocols (HTTP, HTTP2 or both). If SSL enabled the protocol is negociated using ALPN. Without SSL enabled only direct HTTP2 connections with prior knowledge are supported.
debug: if defined log the TCP traffic with the provided logger name. Default to None.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ServerOptions
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new ServerOptions(ioThreads: Int = ..., tcpNoDelay: Boolean = true, bufferSize: Option[Int] = None, protocols: Set[String] = Set(HTTP), debug: Option[String] = None)
ioThreads
the number of threads used for the IO work. Default to max(availableProcessors, 2).
tcpNoDelay
if true disable Nagle's algorithm. Default true.
bufferSize
if defined used as a hint for the TCP buffer size. If none use the system default. Default to None.
protocols
the allowed protocols (HTTP, HTTP2 or both). If SSL enabled the protocol is negociated using ALPN. Without SSL enabled only direct HTTP2 connections with prior knowledge are supported.
debug
if defined log the TCP traffic with the provided logger name. Default to None.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bufferSize: Option[Int]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val debug: Option[String]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val ioThreads: Int
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val protocols: Set[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tcpNoDelay: Boolean
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped