Finagle Websocket clients and servers
Scala Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Finagle Websocket

Build status Coverage status Project status

Websockets support for Finagle


This project is inactive. While we are keep it up to date with new Finagle releases, it is not currently being actively used or developed. If you're using Finagle Websocket and would be interested in discussing co-ownership, please file an issue.

Using websockets

Adding dependencies





resolvers += "com.github.sprsquish" at ""

"com.github.sprsquish" %% "finagle-websockets" % "6.8.1"


The following client and server can be run by pasting the code into sbt console. The client sends "1" over to the server. The server responds by translating the numeral into an word (mostly). When the client receives this word, it will send back a number which represents the length of characters of the received word.


import com.twitter.concurrent.AsyncStream
import com.twitter.conversions.time._
import com.twitter.finagle.Websocket
import com.twitter.finagle.util.DefaultTimer
import com.twitter.finagle.websocket.{Frame, Request}
import com.twitter.util.Promise

implicit val timer = DefaultTimer.twitter

// Responds to messages from the server.
def handler(messages: AsyncStream[Frame]): AsyncStream[Frame] =
  messages.flatMap {
    case Frame.Text(message) =>
      // Print the received message.

        // Sleep for a second...
        Future.sleep(1.second).map { _ =>
          // ... and then send a message to the server.

    case _ => AsyncStream.of(Frame.Text("??"))

val incoming = new Promise[AsyncStream[Frame]]
val outgoing =
  Frame.Text("1") +:: handler(

val client = Websocket.client.newService(":14000")
val req = Request(new URI("/"), Map.empty, null, outgoing)

// Take the messages of the response and fulfill `incoming`.


import com.twitter.concurrent.AsyncStream
import com.twitter.finagle.{Service, Websocket}
import com.twitter.finagle.websocket.{Frame, Request, Response}
import com.twitter.util.Future

// A server that when given a number, responds with a word (mostly).
def handler(messages: AsyncStream[Frame]): AsyncStream[Frame] = { {
    case Frame.Text("1") => Frame.Text("one")
    case Frame.Text("2") => Frame.Text("two")
    case Frame.Text("3") => Frame.Text("three")
    case Frame.Text("4") => Frame.Text("cuatro")
    case Frame.Text("5") => Frame.Text("five")
    case Frame.Text("6") => Frame.Text("6")
    case _ => Frame.Text("??")

Websocket.serve(":14000", new Service[Request, Response] {
  def apply(req: Request): Future[Response] =