akka/akka-http

Create API variants for websockets that accept Source or Sink

Open

#445 opened on Oct 28, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedsmallt:routing

Repository metrics

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

Description

Many people want just one-directional communcation, so they have a Sink or Source, we should give them helper APIs to be able to use them without hassle.

Contributor guide

Research direction
Examine the existing WebSocket API in akka http, specifically the handleWebSocketMessages function that requires a Flow[Message, Message, Any]. Understand how Source and Sink are used. Look for patterns in the codebase where similar helper APIs exist for one directional communication. Design new API variants that accept either a Source[Message, ] (for outgoing) or Sink[Message, ] (for incoming) and wrap them into a flow. Consider error handling and materialization. Test the new APIs with example usage.
Tech stack
scala
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
ScalaAkka StreamsWebSockets
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65