Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilyamatsuev/apex-websocket-client
The library for handling sending and receiving updates by WebSocket protocol in Apex.
https://github.com/ilyamatsuev/apex-websocket-client
apex library salesforce salesforce-apex websocket websocket-client websockets ws wss
Last synced: 28 days ago
JSON representation
The library for handling sending and receiving updates by WebSocket protocol in Apex.
- Host: GitHub
- URL: https://github.com/ilyamatsuev/apex-websocket-client
- Owner: IlyaMatsuev
- License: mit
- Created: 2022-01-21T15:12:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-05T18:54:58.000Z (about 2 years ago)
- Last Synced: 2024-11-12T12:53:01.918Z (3 months ago)
- Topics: apex, library, salesforce, salesforce-apex, websocket, websocket-client, websockets, ws, wss
- Language: Apex
- Homepage:
- Size: 104 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Apex WebSocket Client
[](https://github.com/IlyaMatsuev/Apex-WebSocket-Client/actions/workflows/scratch-org-ci.yml)
[](https://codecov.io/gh/IlyaMatsuev/Apex-WebSocket-Client)
Salesforce Apex library that is aimed to provide support for the WebSocket protocol. Which can be used directly from Apex runtime (not only via LWC JS).
Of course, there is no native support for WebSocket in Apex yet. This project uses an external server that redirects HTTP requests as WebSocket messages.
## Overview
To handle WebSocket events you need to create a handler class that is going to handle incoming messages, errors, or connection closing:
```java
public class WebSocketMessageHandler implements IWSMessageHandler {
public void handle(WSConnection connection, Map args) {
// Get the new incoming messages (if there are any)
List newMessages = connection.getUpdates();
// Send a message back to the WebSocket server
connection.send('Message back!');
// We can also request closing connection if we need to
//connection.close();
}
}
```
This is how you connect to the WebSocket server:
```java
WSClient client = new WSClient();
// Register onMessage event handler
client.onMessage(WebSocketMessageHandler.class);
// Connect to the WebSocket server and receive the connection object
WSConnection connection = client.connect('wss://some-ws-endpoint.com');
// With the connection object we can send a new message or close the connection
connection.send('Hello World!');
```
For more examples, please refer to [here](docs/examples).
**Be aware, that this package uses a lot of Platform Events and Queueable Apex jobs to make things work. It can affect your organization's [governor limits](https://developer.salesforce.com/docs/atlas.en-us.234.0.platform_events.meta/platform_events/platform_event_limits.htm).**
_Let's say we receive a new message every 10 seconds. For a minute of an established connection, it submits approximately 2-4 Queueable Apex jobs and fires 6-18 Platform Events (depending on the amount of registered handlers)._
## Installation
### From Unmanaged Package
You can just install the package by the link on a [sandbox](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001zNZfQAM) or [dev org](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001zNZfQAM).
If you prefer using salesforce CLI you can run:
```
sfdx force:package:install -p 04t5Y000001zNZfQAM -w 10 -b 10 -u
```
### From Source
You can also install the package with the automated scripts: [`pkg-deploy.sh`](scripts/pkg-deploy.sh) and [`pkg-from-scratch.sh`](scripts/pkg-from-scratch.sh).
First is for deploying changes to the existing org.
```
./scripts/pkg-deploy.sh
```
Second is for creating a new configured scratch org.
```
./scripts/pkg-from-scratch.sh
```
## Configuration
The library can be used as it is without any additional configuration, or it can be used with your own server running (which is recommended). For more details about how to run your server instance visit [this page](src/ws-dispatcher).
Also, don't forget to assign the `ApexWSClientUser` permission set to the necessary users and update the [`WSDispatcherSetting__c`](docs/README.md#wsdispatchersettingc) custom settings.
## Documentation
For more detailed information about the content of the repository and sfdx package, please visit [docs folder](docs).
## Questions
If you have any questions you can start a discussion.
If you think something works not as expected or you want to request a new feature, you can create an issue with the appropriate template selected.
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](LICENSE)