Blazing fast NIO microframework and Http Parser
Latest commit c8f2478 Oct 20, 2018

README.md

blaze Build Status Build status Maven Central

blaze is a Scala library for building asynchronous pipelines, with a focus on network IO. Its main goal is to service the network needs of the http4s project, but may find application elsewhere.

Features

  • Completely asynchronous pull based design
  • Type safe pipeline composition
  • NIO1 and NIO2 socket engines
  • SSL integration
  • HTTP/1.x and HTTP2 codecs
  • Basic HTTP/1.x server and client
  • Basic HTTP2 server

blazes goals are

  • Provides an IO framework to support the core http4s project
  • Speed is the first priority
  • Asynchronous using Scala 2.10 Futures as the underpinning
  • Java NIO backend for fast/asynchronous network and file I/O
  • Offer a framework for rapid development of fast, asynchronous pipelines using Scala

What blaze is not

  • Purely functional. Functional is preferred except when in conflict with the first goal.
  • Raw blaze doesn't promise a stable API. The primary goal of blaze is to support the http4s project and as such, the raw blaze API may evolve to meet the needs of http4s. The API of http4s is rapidly approaching 1.0, and at that point the raw blaze API will begin the process of stabilizing.

Asynchronous network I/O

blaze was built with the Java 7 NIO2 features in mind. NIO2 offers a host of new features which are offered in a unified way. blaze offers TCP socket server support for both NIO1 and NIO2, depending on your preference. NIO1 tends to be the better performing technology for raw sockets.

Getting started

For a quick start, look in the examples project for some simple examples of HTTP, WebSocket, and a simple EchoServer.

Important blaze behaviors

  • By default, read and write requests should be serialized either manually, or with a SerializerStage.

Data flow

Useful asynchronous processing is done through the construction of a pipeline. A pipeline is composed of individual stages that perform operations such as decoding/encoding, SSL encryption, buffering, etc. The pipeline is constructed in a type safe manner using the PipelineBuilder types.

blaze is a pull based framework as opposed to the reactor and actor models found in other systems. Therefore, data flow is typically controlled by the tail of the pipeline. Data is written and requested using the Future type found in the Scala standard library.

blaze doesn't make any assumptions as to whether any stage is thread safe, so as noted above, either manually ensure a write is not performed before the previous write has completed and the same for reads, or use a SerializerStage or Serializer mixin to automatically sequence reads and writes for you.

Development

blaze is under active development and at this stage, everything is candidate for change. However, many features are reaching maturity, and will likely remain stable.

Contributors

The Contributors, as calculated by GitHub. Contributions and comments in the form of issues or pull requests are greatly appreciated.

Acknowledgments

Several concepts are inspired by the Jetty and Netty projects.

Licence

Blaze is licensed under the Apache 2 license. See the LICENSE file in the root project directory for more information.