akka/akka-core

Add notes about shutdown patterns for Streams to docs

开放

#22,183 创建于 2017年1月23日

 (2 条评论) (0 个反应) (0 位负责人)Scala (3,547 个派生)batch import
1 - triagedhelp wantedt:docs

仓库指标

星标
 (13,277 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

As a newbie, I ran into a case where I couldn't understand how to terminate the ActorSystem, used to materialize the Stream, after the latter has finished it work. I scanned through the titles in the doc and couldn't find a word about shutdown patterns. The onComplete() callback (which was an obvious choice) unexpectedly fired right after my pipeline was run. Thanks to akka gitter chat and @ktoso, I was pointed towards "Custom materialized values" section, because it turned out I didn't use one in my custom Sink, and that's why onComplete() fired too early. But it was very unobvious to me as a beginner.

So it'd be great if there will be some small section in the beginning of the Streams doc, that has a keyword "shutdown" or similar and explains basic necessity of Mat values for signaling completition of a stream with an example of a proper shutdown pattern.

贡献者指南