extractUpgradeToWebSocket

def extractUpgradeToWebSocket: Directive1[UpgradeToWebSocket]

Description

Extracts the UpgradeToWebSocketUpgradeToWebSocket header if existent. Rejects with an ExpectedWebSocketRequestRejectionExpectedWebSocketRequestRejection, otherwise.

The extractUpgradeToWebSocket directive is used as a building block for Custom Directives to provide the extracted header to the inner route.

Example

Scala

def echoService: Flow[Message, Message, Any] =
  Flow[Message]
    // needed because a noop flow hasn't any buffer that would start processing in tests
    .buffer(1, OverflowStrategy.backpressure)

def route =
  path("services") {
    extractUpgradeToWebSocket { upgrade ⇒
      complete(upgrade.handleMessages(echoService, Some("echo")))
    }
  }

// tests:
val wsClient = WSProbe()

// WS creates a WebSocket request for testing
WS("/services", wsClient.flow, Nil) ~> route ~> check {
  expectWebSocketUpgradeWithProtocol { protocol =>
    protocol shouldEqual "echo"
    wsClient.sendMessage("ping")
    wsClient.expectMessage("ping")
    wsClient.sendCompletion()
    wsClient.expectCompletion()
  }
}

Java

final Flow<Message, Message, NotUsed> echoService = Flow.of(Message.class).buffer(1, OverflowStrategy.backpressure());

final Route websocketRoute = path("services", () ->
  route(
    extractUpgradeToWebSocket(upgrade ->
      complete(upgrade.handleMessagesWith(echoService, "echo"))
    )
  )
);

// tests:
// create a testing probe representing the client-side
final WSProbe wsClient = WSProbe.create(system(), materializer());

// WS creates a WebSocket request for testing
testRoute(websocketRoute)
  .run(WS(Uri.create("/services"), wsClient.flow(), materializer(), Collections.emptyList()))
  .assertHeaderExists(SecWebSocketProtocol.create("echo"));

wsClient.sendMessage("ping");
wsClient.expectMessage("ping");

wsClient.sendCompletion();
wsClient.expectCompletion();