forked from cerc-io/ipld-eth-server
115 lines
2.5 KiB
Markdown
115 lines
2.5 KiB
Markdown
# go-stream-muxer - generalized stream multiplexing
|
|
|
|
|
|
go-stream-muxer is a common interface for stream muxers, with common tests. It wraps other stream muxers (like [muxado](https://github.com/inconshreveable/muxado), [spdystream](https://github.com/docker/spdystream) and [yamux](https://github.com/hashicorp/yamux)).
|
|
|
|
[](http://ipn.io) [](http://webchat.freenode.net/?channels=%23ipfs)
|
|
|
|
> A test suite and interface you can use to implement a stream muxer.
|
|
|
|
### Godoc: https://godoc.org/github.com/libp2p/go-stream-muxer
|
|
|
|
## Implementations
|
|
|
|
* [yamux](https://github.com/whyrusleeping/go-smux-yamux)
|
|
* [muxado](https://github.com/whyrusleeping/go-smux-muxado)
|
|
* [multiplex](https://github.com/whyrusleeping/go-smux-multiplex)
|
|
* [spdystream](https://github.com/whyrusleeping/go-smux-spdystream)
|
|
|
|
## Badge
|
|
|
|
Include this badge in your readme if you make a new module that uses abstract-stream-muxer API.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
go get -d github.com/libp2p/go-stream-muxer
|
|
cd $GOPATH/src/github.com/libp2p/go-stream-muxer
|
|
make deps
|
|
```
|
|
|
|
## Client example
|
|
|
|
```go
|
|
import (
|
|
"net"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
|
|
ymux "github.com/whyrusleeping/go-smux-yamux"
|
|
)
|
|
|
|
func dial() {
|
|
nconn, _ := net.Dial("tcp", "localhost:1234")
|
|
sconn, _ := ymux.DefaultTransport.NewConn(nconn, false) // false == client
|
|
|
|
go func() {
|
|
// no-op
|
|
for {
|
|
sconn.AcceptStream()
|
|
}
|
|
}()
|
|
|
|
s1, _ := sconn.OpenStream()
|
|
s1.Write([]byte("hello"))
|
|
|
|
s2, _ := sconn.OpenStream()
|
|
s2.Write([]byte("world"))
|
|
|
|
length := 20
|
|
buf2 := make([]byte, length)
|
|
fmt.Printf("reading %d bytes from stream (echoed)\n", length)
|
|
|
|
s1.Read(buf2)
|
|
|
|
fmt.Printf("received %s as a response\n", string(buf2))
|
|
|
|
s3, _ := sconn.OpenStream()
|
|
io.Copy(s3, os.Stdin)
|
|
}
|
|
```
|
|
|
|
## Server example
|
|
|
|
```go
|
|
import (
|
|
"net"
|
|
"fmt"
|
|
"io"
|
|
|
|
smux "github.com/libp2p/go-stream-muxer"
|
|
ymux "github.com/whyrusleeping/go-smux-yamux"
|
|
)
|
|
|
|
func listen() {
|
|
tr := ymux.DefaultTransport
|
|
l, _ := net.Listen("tcp", "localhost:1234")
|
|
|
|
for {
|
|
c, _ := l.Accept()
|
|
|
|
fmt.Println("accepted connection")
|
|
sc, _ := tr.NewConn(c, true)
|
|
|
|
go func() {
|
|
fmt.Println("serving connection")
|
|
for {
|
|
s, _ := sc.AcceptStream()
|
|
echoStream(s)
|
|
}
|
|
}()
|
|
}
|
|
}
|
|
|
|
func echoStream(s smux.Stream) {
|
|
defer s.Close()
|
|
|
|
fmt.Println("accepted stream")
|
|
io.Copy(s, s) // echo everything
|
|
fmt.Println("closing stream")
|
|
}
|
|
```
|