https://github.com/mono424/go-pts
Go Library for WebSocket Channel Management ✨
https://github.com/mono424/go-pts
go golang websocket
Last synced: 5 months ago
JSON representation
Go Library for WebSocket Channel Management ✨
- Host: GitHub
- URL: https://github.com/mono424/go-pts
- Owner: mono424
- License: mit
- Created: 2022-09-25T23:08:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T18:36:18.000Z (over 1 year ago)
- Last Synced: 2025-10-10T06:42:35.280Z (9 months ago)
- Topics: go, golang, websocket
- Language: Go
- Homepage:
- Size: 181 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Go (Pneumatic) Tube System
[](https://github.com/mono424/go-pts/actions/workflows/run-tests.yml)
[](https://goreportcard.com/report/github.com/mono424/go-pts)
[](https://codecov.io/gh/mono424/go-pts)
Go-PTS is a flexible package for managing Pub-Sub over WebSockets in Go. It offers a rest-style syntax and easily integrates with various websocket and http frameworks.
## Installation
### Installing the main library
1. Get the `go-pts` package using the following command:
```shell
go get github.com/mono424/go-pts
```
### Using connectors
To use go-pts with a specific websocket library, you need to install the corresponding connector.
```shell
go get github.com/mono424/go-pts-gorilla-connector
```
Then, you can import them in your code like this:
```go
import (
"github.com/mono424/go-pts"
ptsc_gorilla "github.com/mono424/go-pts-gorilla-connector"
)
```
## Client Libraries
For client-side integration, you can use one of the following client libraries:
| Language | URL |
| -------- | --- |
| JavaScript | [go-pts-client-js](https://github.com/mono424/go-pts-client-js) |
| Dart | [go-pts-client-dart](https://github.com/mono424/go-pts-client-dart) |
## Connectors
For server-side integration with WebSocket libraries, you can use one of the following connectors:
| WebSocket Library | URL |
| ----------------- | --- |
| Gorilla WebSocket | [go-pts-gorilla-connector](https://github.com/mono424/go-pts-gorilla-connector) |
| Melody | [go-pts-melody-connector](https://github.com/mono424/go-pts-melody-connector) |
## Getting Started
1. Create a new TubeSystem
```go
tubeSystem := pts.New(ptsc_gorilla.NewConnector(
websocket.Upgrader{},
func(err *pts.Error) {
println(err.Description)
},
))
```
2. Register Channels
```go
tubeSystem.RegisterChannel("/stream/:streamId", pts.ChannelHandlers{
OnSubscribe: func(s *pts.Context) {
println("Client joined: " + s.FullPath)
},
OnMessage: func(s *pts.Context, message *pts.Message) {
println("New Message on " + s.FullPath + ": " + string(message.Payload))
},
OnUnsubscribe: func(s *pts.Context) {
println("Client left: " + s.FullPath)
},
})
```
3. Provide a connect route
```go
r.GET("/connect", func(c *gin.Context) {
properties := make(map[string]interface{}, 1)
properties["ctx"] = c
if err := tubeSystem.HandleRequest(c.Writer, c.Request, properties); err != nil {
println("Something went wrong while handling a Socket request")
}
})
```
4. Connect from a frontend lib
```javascript
const client = new GoPTSClient({ url: socketUrl, debugging: true })
client.subscribeChannel("test", console.log);
client.send("test", { payload: { foo: "bar" } })
```
## Examples
To get a quick overview of how to use Go-PTS, check out the `examples` folder.