Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
oklemenz2 committed Jan 24, 2024
1 parent c0a4876 commit 9ff7ef2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,14 @@ In browser environment implement the websocket client: **index.html**

![WebSocket Overview](./docs/assets/overview.png)

The CDS Websocket module supports the following use-cases:

- Connect multiple websocket clients (browser and non-browser) to CAP server websockets
- Process websockets messages as CDS entity CRUD, action and function calls
- Broadcast CDS events across local server websockets and multi-instance server websockets (via Redis)
- Broadcast CDS events across multiple CAP server applications and application instances (via Redis)
- Emit/Broadcast CDS events from server websockets to websocket clients (browser and non-browser)

### WebSocket Server

The websocket server is exposed on `cds` object implementation-independent at `cds.ws` and implementation-specific at
Expand Down
20 changes: 10 additions & 10 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"devDependencies": {
"@cap-js-community/websocket": "./",
"@cap-js/sqlite": "^1.4.0",
"@sap/cds": "^7.5.2",
"@sap/cds": "^7.5.3",
"@sap/cds-dk": "^7.5.1",
"@sap/xssec": "3.6.1",
"@socket.io/redis-adapter": "^8.2.1",
Expand Down

0 comments on commit 9ff7ef2

Please sign in to comment.