Skip to content

Commit ff7e3e7

Browse files
CopilotSandPod
andauthored
fix: Add deprecation notice to Streaming Endpoints (serverpod#348)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: SandPod <137198655+SandPod@users.noreply.github.com>
1 parent 5351001 commit ff7e3e7

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/06-concepts/15-streams.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
For some applications, it's not enough to be able to call server-side methods. You may also want to push data from the server to the client or send data two-way. Examples include real-time games or chat applications. Luckily, Serverpod supports a framework for streaming data. It's possible to stream any serialized objects to or from any endpoint.
44

5-
Serverpod supports two ways to stream data. The first approach, [streaming methods](#streaming-methods), imitates how `Streams` work in Dart and offers a simple interface that automatically handles the connection with the server. In contrast, the second approach, [streaming endpoint](#streaming-endpoints), requires developers to manage the web socket connection. The second approach was Serverpod's initial solution for streaming data but will be removed in future updates.
5+
Serverpod supports streaming data through [streaming methods](#streaming-methods), which imitate how `Streams` work in Dart and offer a simple interface that automatically handles the connection with the server.
66

77
:::tip
88

@@ -118,7 +118,11 @@ In the example above, the client sends an error to the server, which then throws
118118

119119
Read more about serializable exceptions here: [Serializable exceptions](exceptions).
120120

121-
## Streaming Endpoints
121+
## Streaming Endpoints (Deprecated)
122+
123+
:::warning
124+
Streaming Endpoints are deprecated and will be removed in a future version of Serverpod. Use [Streaming Methods](#streaming-methods) instead for a simpler and more robust streaming experience.
125+
:::
122126

123127
Streaming endpoints were Serverpod's first attempt at streaming data. This approach is more manual, requiring developers to manage the WebSocket connection to the server.
124128

0 commit comments

Comments
 (0)