Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pdf/websocketrwc
Golang package that wraps Gorilla websocket in an io.ReadWriteCloser interface
https://github.com/pdf/websocketrwc
encoding go golang golang-library readwritecloser websocket
Last synced: 2 months ago
JSON representation
Golang package that wraps Gorilla websocket in an io.ReadWriteCloser interface
- Host: GitHub
- URL: https://github.com/pdf/websocketrwc
- Owner: pdf
- Created: 2017-02-03T22:43:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-02T23:25:16.000Z (over 7 years ago)
- Last Synced: 2024-06-20T16:48:25.659Z (7 months ago)
- Topics: encoding, go, golang, golang-library, readwritecloser, websocket
- Language: Go
- Size: 2.93 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://godoc.org/github.com/pdf/websocketrwc) 
# websocketrwc
--
import "github.com/pdf/websocketrwc"
Package websocketrwc wraps Gorilla websocket in an io.ReadWriteCloser compatible
interface, allowing it to be used as a net/rpc or similar connection. Only the
server side is currently implemented.
## Usage
```go
var (
// ErrClosing is returned for operations during close phase.
ErrClosing = errors.New(`Closing`)
// DefaultUpgrader will be used if a nil upgrader is passed to Upgrade().
DefaultUpgrader = &websocket.Upgrader{
HandshakeTimeout: defaultHandshakeTimeout,
ReadBufferSize: defaultBufferSize,
WriteBufferSize: defaultBufferSize,
EnableCompression: true,
CheckOrigin: func(r *http.Request) bool { return true },
}
// WriteTimeout determines the period of time a write will wait to complete
// before producing an error.
WriteTimeout = 10 * time.Second
// PongTimeout determines the period of time a connection will wait for a
// Pong response to Pings sent to the client.
PongTimeout = 60 * time.Second
// PingInterval determins the interval at which Pings are sent to the
// client.
PingInterval = (PongTimeout * 9) / 10
)
```
#### type Conn
```go
type Conn struct {
}
```
Conn wraps gorilla websocket to provide io.ReadWriteCloser.
#### func Upgrade
```go
func Upgrade(w http.ResponseWriter, r *http.Request, h http.Header, upgrader *websocket.Upgrader) (*Conn, error)
```
Upgrade a HTTP connection.
#### func (*Conn) Close
```go
func (c *Conn) Close() error
```
Close implements io.Closer and closes the underlying connection.
#### func (*Conn) Read
```go
func (c *Conn) Read(p []byte) (n int, err error)
```
Read implements io.Reader by wrapping websocket messages in a buffer.
#### func (*Conn) Write
```go
func (c *Conn) Write(p []byte) (n int, err error)
```
Write implements io.Writer and sends binary messages only.