Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notcoffee418/websocketmanager
Abstraction on top of gorilla/websocket to manage communication and identification for websockets
https://github.com/notcoffee418/websocketmanager
go golang gorilla-websocket websocket-server websockets
Last synced: 9 days ago
JSON representation
Abstraction on top of gorilla/websocket to manage communication and identification for websockets
- Host: GitHub
- URL: https://github.com/notcoffee418/websocketmanager
- Owner: NotCoffee418
- License: mit
- Created: 2023-10-01T14:31:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-13T23:49:57.000Z (over 1 year ago)
- Last Synced: 2024-11-22T22:15:15.877Z (2 months ago)
- Topics: go, golang, gorilla-websocket, websocket-server, websockets
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebSocket Manager
WebSocket Manager is a Go library that simplifies managing WebSocket connections. It offers functionalities like upgrading HTTP connections to WebSocket, managing clients, broadcasting messages, and more.
This library is an abstraction on top of the [gorilla/websocket](https://github.com/gorilla/websocket) library.
## Installation
Install the package using `go get`:
```bash
go get github.com/NotCoffee418/websocketmanager
```
Add the package to your code:
```go
import "github.com/NotCoffee418/websocketmanager"
```
## Usage
Here's how to use WebSocket Manager in your Go application.
### Initialize Manager
Create a new instance of the Manager type using one of the following methods:
```go
// Create a manager with default settings
wsManager := websocketmanager.NewDefaultManager()
// Create a manager with customized settings
wsManager := websocketmanager.NewBuilder().
WithReadBufferSize(2048).
WithWriteBufferSize(2048).
WithClientCleanupDisabled().
Build()
```
### Upgrade HTTP Connection to WebSocket
Upgrade an incoming HTTP request to a WebSocket connection:
```go
func ginHandler(c *gin.Context) {
wsClient <- wsManager.UpgradeClient(c.Writer, c.Request)
//...
}
```
This library is agnostic to the specific Go web framework used, as long as the framework is based on Go's standard `net/http` package.
### Assign Groups
To categorize clients into groups, use the `AssignGroups` method:
```go
wsManager.AssignGroups(*client.ConnId, 1, 2)
```
### Register Observers
To observe messages from a specific client, register an observer function:
```go
wsManager.RegisterClientObserver(*client.ConnId, func(wsClient *websocketmanager.Client, messageType int, message []byte) {
// Handle incoming message
})
```
### Send Messages
To send messages, you have the following options:
- Broadcast a message to all clients
```go
wsManager.BroadcastMessage(messageType, message)
```
- Send a message to a specific group of clients
```go
wsManager.SendMessageToGroup(groupID, messageType, message)
```
- Send a message to a specific client
```go
wsManager.SendMessageToUser(clientUUID, messageType, message)
```
Message type definitions can be found in the [gorilla/websocket](https://github.com/gorilla/websocket/blob/666c197fc9157896b57515c3a3326c3f8c8319fe/conn.go#L63) library.
```go
messageType := websocket.TextMessage
```
### Manage Clients
You can manually unregister clients or retrieve specific clients by their UUID:
- To unregister a client:
```go
wsManager.Unregister(clientUUID)
```
- To get a specific client:
```go
client, err := wsManager.GetWebSocketClient(clientUUID)
```
### Cleanup
By default, WebSocket Manager will automatically clean up inactive clients. You can disable this during the initialization step if needed.
## Contributing
Contributions are welcome. Feel free to open a pull request or issue on GitHub.
## License
This project is licensed under the MIT License.
For more information, please refer to the [LICENSE](LICENSE) file in the repository.