akka/akka-core

Expand on closing IncomingConnection in documentation

Open

#19,940 opened on Mar 2, 2016

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:stream

Description

At http://doc.akka.io/docs/akka/2.4.2/scala/stream/stream-io.html, the second paragraph after the second code block states:

Closing connections is possible by cancelling the incoming connection Flow from your server logic (e.g. by connecting its downstream to a Sink.cancelled and its upstream to a Source.empty). It is also possible to shut down the server's socket by cancelling the IncomingConnection source connections.

Please provide a code example of how to do this.

Contributor guide

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.
2
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
Scala basicsAkka Streams fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the current documentation at http://doc.akka.io/docs/akka/2.4.2/scala/stream/stream io.html, specifically the paragraph after the second code block. Create a code example demonstrating how to cancel the incoming connection Flow as described. The example should be written in Scala and follow the style of existing code examples in the Akka documentation. Consider adding the example directly below the mentioned paragraph. Also review any comments in the issue for additional context.