Skip to content

Commit

Permalink
Merge pull request #1775 from ChristopherDavenport/blazeBuilderDocs0.18
Browse files Browse the repository at this point in the history
Adding Scaladoc for BlazeBuilder
  • Loading branch information
ChristopherDavenport committed Apr 11, 2018
2 parents 6d1f8b0 + 05b77c1 commit f4f39f2
Showing 1 changed file with 29 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,35 @@ import scala.collection.immutable
import scala.concurrent.{ExecutionContext, Future}
import scala.concurrent.duration._

/**
* BlazeBuilder is the component for the builder pattern aggregating
* different components to finally serve requests.
*
* Variables:
* @param socketAddress: Socket Address the server will be mounted at
* @param executionContext: Execution Context the underlying blaze futures
* will be executed upon.
* @param idleTimeout: Period of Time a connection can remain idle before the
* connection is timed out and disconnected.
* Duration.Inf disables this feature.
* @param isNio2: Whether or not to use NIO2 or NIO1 Socket Server Group
* @param connectorPoolSize: Number of worker threads for the new Socket Server Group
* @param bufferSize: Buffer size to use for IO operations
* @param enableWebsockets: Enables Websocket Support
* @param sslBits: If defined enables secure communication to the server using the
* sslContext
* @param isHttp2Enabled: Whether or not to enable Http2 Server Features
* @param maxRequestLineLength: Maximum request line to parse
* If exceeded returns a 400 Bad Request.
* @param maxHeadersLen: Maximum data that composes the headers.
* If exceeded returns a 400 Bad Request.
* @param serviceMounts: The services that are mounted on this server to serve.
* These services get assembled into a Router with the longer prefix winning.
* @param serviceErrorHandler: The last resort to recover and generate a response
* this is necessary to recover totality from the error condition.
* @param banner: Pretty log to display on server start. An empty sequence
* such as Nil disables this
*/
class BlazeBuilder[F[_]](
socketAddress: InetSocketAddress,
executionContext: ExecutionContext,
Expand Down

0 comments on commit f4f39f2

Please sign in to comment.