Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sivaosorg/unused-ngx-blobs-wss

Config middleware base websocket and socket
https://github.com/sivaosorg/unused-ngx-blobs-wss

websocket websocket-application websocket-client websocket-proxy websocket-server

Last synced: 17 days ago
JSON representation

Config middleware base websocket and socket

Awesome Lists containing this project

README

        


Eagle logo

Config middleware base websocket and socket


The base library including publish websocket via url


## ⚡️ Quick start

Build application:

```bash
/bin/bash gradlew jar
```
> output jar: ngx-blobs-wss-1.0.0.jar

## :rocket: Functions

#### Tunnel properties

:package: add file [`application-tunnels.yml`](src/main/resources/application-tunnels.yml)

```yml
spring:
tunnel-socket-starter:
enabled: true # enable websocket
tunnels:
- enabled: true # enable this url will be published
endpoint-short-url: /publish/event # url websocket
endpoint-description: tunning on socket v1
hashtag: '#pbx'
pool-threshold: 10
- enabled: true
endpoint-short-url: /publish/action
endpoint-description: tunning on socket v2
hashtag: '#topic-sample'
pool-threshold: 5
config:
enabled: false
allow-display-skipped-log: false # enable logging for messages
message:
fields-ignored:
- logs
- privileges
```

#### Services

- `NgxWebsocketBaseService`: this service use to publish event

- `MessagesSocketPublisherRequest>`: model will be published event

```json
{
"topic": "CALLBACK",
"message": {
"username": "[email protected]",
"age": 32,
"content": "this is me"
}
}
```