https://github.com/paloaltonetworks/wsc
wsc is a library that allows to interact with web sockets using channels.
https://github.com/paloaltonetworks/wsc
Last synced: about 1 month ago
JSON representation
wsc is a library that allows to interact with web sockets using channels.
- Host: GitHub
- URL: https://github.com/paloaltonetworks/wsc
- Owner: PaloAltoNetworks
- License: apache-2.0
- Created: 2018-12-11T21:10:19.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-01T23:18:52.000Z (5 months ago)
- Last Synced: 2025-08-12T16:50:32.075Z (3 months ago)
- Language: Go
- Size: 97.7 KB
- Stars: 13
- Watchers: 14
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WSC
[](https://www.codacy.com/gh/PaloAltoNetworks/wsc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=PaloAltoNetworks/wsc&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/PaloAltoNetworks/wsc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=PaloAltoNetworks/wsc&utm_campaign=Badge_Coverage)
WSC (WebSocket Channel) is a library that can be used to manage github.com/gorilla/websocket using channels.
It provides 2 main functions:
- `func Connect(ctx context.Context, url string, config Config) (Websocket, *http.Response, error)`
- `func Accept(ctx context.Context, conn WSConnection, config Config) (Websocket, error)`
The interface `WSConnection` is used to interract with the websocket:
```go
// Websocket is the interface of channel based websocket.
type Websocket interface {
// Reads returns a channel where the incoming messages are published.
// If nothing pumps the Read() while it is full, new messages will be
// discarded.
//
// You can configure the size of the read chan in Config.
// The default is 64 messages.
Read() chan []byte
// Write writes the given []byte in to the websocket.
// If the other side of the websocket cannot get all messages
// while the internal write channel is full, new messages will
// be discarded.
//
// You can configure the size of the write chan in Config.
// The default is 64 messages.
Write([]byte)
// Done returns a channel that will return when the connection
// is closed.
//
// The content will be nil for clean disconnection or
// the error that caused the disconnection. If nothing pumps the
// Done() channel, the error will be discarded.
Done() chan error
// Close closes the websocket.
//
// Closing the websocket a second time has no effect.
// A closed Websocket cannot be reused.
Close(code int)
// Error returns a channel that will return errors like
// read or write discards and other errors that are not
// terminating the connection.
//
// If nothing pumps the Error() channel, the error will be discarded.
Error() chan error
}
```