README
¶
shapeio
Traffic shaper for Golang io.Reader and io.Writer
import "github.com/fujiwara/shapeio"
func ExampleReader() {
// example for downloading http body with rate limit.
resp, _ := http.Get("http://example.com")
defer resp.Body.Close()
reader := shapeio.NewReader(resp.Body)
reader.SetRateLimit(1024 * 10) // 10KB/sec
io.Copy(ioutil.Discard, reader)
}
func ExampleWriter() {
// example for writing file with rate limit.
src := bytes.NewReader(bytes.Repeat([]byte{0}, 32*1024)) // 32KB
f, _ := os.Create("/tmp/foo")
writer := shapeio.NewWriter(f)
writer.SetRateLimit(1024 * 10) // 10KB/sec
io.Copy(writer, src)
f.Close()
}
Usage
type Reader
type Reader struct {
}
func NewReader
func NewReader(r io.Reader) *Reader
NewReader returns a reader that implements io.Reader with rate limiting.
func (*Reader) Read
func (s *Reader) Read(p []byte) (int, error)
Read reads bytes into p.
func (*Reader) SetRateLimit
func (s *Reader) SetRateLimit(l float64)
SetRateLimit sets rate limit (bytes/sec) to the reader.
type Writer
type Writer struct {
}
func NewWriter
func NewWriter(w io.Writer) *Writer
NewWriter returns a writer that implements io.Writer with rate limiting.
func (*Writer) SetRateLimit
func (s *Writer) SetRateLimit(l float64)
SetRateLimit sets rate limit (bytes/sec) to the writer.
func (*Writer) Write
func (s *Writer) Write(p []byte) (int, error)
Write writes bytes from p.
License
The MIT License (MIT)
Copyright (c) 2016 FUJIWARA Shunichiro
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Example ¶
package main
import (
"io"
"io/ioutil"
"net/http"
"github.com/cryks/shapeio"
)
func main() {
// example for downloading http body with rate limit.
resp, _ := http.Get("http://example.com")
defer resp.Body.Close()
reader := shapeio.NewReader(resp.Body)
reader.SetRateLimit(1024 * 10) // 10KB/sec
io.Copy(ioutil.Discard, reader)
}
Output:
func NewReaderWithContext ¶
NewReaderWithContext returns a reader that implements io.Reader with rate limiting.
func (*Reader) SetRateLimit ¶
SetRateLimit sets rate limit (bytes/sec) to the reader.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Example ¶
package main
import (
"bytes"
"io"
"os"
"github.com/cryks/shapeio"
)
func main() {
// example for writing file with rate limit.
src := bytes.NewReader(bytes.Repeat([]byte{0}, 32*1024)) // 32KB
f, _ := os.Create("/tmp/foo")
writer := shapeio.NewWriter(f)
writer.SetRateLimit(1024 * 10) // 10KB/sec
io.Copy(writer, src)
f.Close()
}
Output:
func NewWriterWithContext ¶
NewWriterWithContext returns a writer that implements io.Writer with rate limiting.
func (*Writer) SetRateLimit ¶
SetRateLimit sets rate limit (bytes/sec) to the writer.
Source Files