akka/akka-http

WebSocket client sample ignores half closed

Open

#1,324 opened on Aug 4, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docst:http:client

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

Issue by johanandren Monday Jul 11, 2016 at 13:11 GMT Originally opened as https://github.com/akka/akka/issues/20938

In #20440 we added docs to describe the behavior of websockets when one direction closes (there is also an open ticket about the actual behavior #19957) but there still is a sample which does not mention this and that users may likely see as the first example of websocket client logic: http://doc.akka.io/docs/akka/2.4.7/scala/http/client-side/websocket-support.html#websocketclientflow

This then makes them spend a week understanding why the socket is closed, we should mention/update the sample. (See for example: https://groups.google.com/d/topic/akka-user/18SExqFsZ5s/discussion )

Contributor guide

Research direction
Locate the WebSocket client sample in the documentation, review the half close behavior description, and update the sample code comment or surrounding text to mention that one direction can close independently.
Tech stack
scala
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitScala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80