syncthing/lib/connections/limitedwriter.go

// Copyright (C) 2014 The Syncthing Authors.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
// You can obtain one at http://mozilla.org/MPL/2.0/.

package connections

import (
	"io"

	"github.com/juju/ratelimit"
)

type LimitedWriter struct {
	writer io.Writer
	bucket *ratelimit.Bucket
}

func NewWriteLimiter(w io.Writer, b *ratelimit.Bucket) *LimitedWriter {
	return &LimitedWriter{
		writer: w,
		bucket: b,
	}
}

func (w *LimitedWriter) Write(buf []byte) (int, error) {
	if w.bucket != nil {
		w.bucket.Wait(int64(len(buf)))
	}
	return w.writer.Write(buf)
}
Use more inclusive copyright header 2014-11-16 13:13:20 -07:00			`// Copyright (C) 2014 The Syncthing Authors.`
Relicense to GPL 2014-09-29 12:43:32 -07:00			`//`
MPLv2 2015-03-07 13:36:35 -07:00			`// This Source Code Form is subject to the terms of the Mozilla Public`
			`// License, v. 2.0. If a copy of the MPL was not distributed with this file,`
			`// You can obtain one at http://mozilla.org/MPL/2.0/.`
Add license header 2014-06-01 13:50:14 -07:00
Decouple connections service from model The connections service no longer depends directly on the syncthing model object, but on an interface instead. This makes it drastically easier to write clients that handle the model differently, but still want to benefit from existing and future connections changes in the core. This was motivated by burkemw3's interest in creating a FUSE client that can present a view of the global model, but not have all of the file data locally. The actual decoupling was done by adding a connections.Model interface. This interface is effectively an extension of the protocol.Model interface that also handles connections alongside the modified service. 2015-09-23 13:03:36 -07:00			`package connections`
Rate limit sent data, not uncompressed 2014-04-01 11:36:54 -07:00
			`import (`
			`"io"`

			`"github.com/juju/ratelimit"`
			`)`

Decouple connections service from model The connections service no longer depends directly on the syncthing model object, but on an interface instead. This makes it drastically easier to write clients that handle the model differently, but still want to benefit from existing and future connections changes in the core. This was motivated by burkemw3's interest in creating a FUSE client that can present a view of the global model, but not have all of the file data locally. The actual decoupling was done by adding a connections.Model interface. This interface is effectively an extension of the protocol.Model interface that also handles connections alongside the modified service. 2015-09-23 13:03:36 -07:00			`type LimitedWriter struct {`
			`writer io.Writer`
Rate limit sent data, not uncompressed 2014-04-01 11:36:54 -07:00			`bucket *ratelimit.Bucket`
			`}`

Decouple connections service from model The connections service no longer depends directly on the syncthing model object, but on an interface instead. This makes it drastically easier to write clients that handle the model differently, but still want to benefit from existing and future connections changes in the core. This was motivated by burkemw3's interest in creating a FUSE client that can present a view of the global model, but not have all of the file data locally. The actual decoupling was done by adding a connections.Model interface. This interface is effectively an extension of the protocol.Model interface that also handles connections alongside the modified service. 2015-09-23 13:03:36 -07:00			`func NewWriteLimiter(w io.Writer, b ratelimit.Bucket) LimitedWriter {`
			`return &LimitedWriter{`
			`writer: w,`
			`bucket: b,`
			`}`
			`}`

			`func (w *LimitedWriter) Write(buf []byte) (int, error) {`
Rate limit sent data, not uncompressed 2014-04-01 11:36:54 -07:00			`if w.bucket != nil {`
			`w.bucket.Wait(int64(len(buf)))`
			`}`
Decouple connections service from model The connections service no longer depends directly on the syncthing model object, but on an interface instead. This makes it drastically easier to write clients that handle the model differently, but still want to benefit from existing and future connections changes in the core. This was motivated by burkemw3's interest in creating a FUSE client that can present a view of the global model, but not have all of the file data locally. The actual decoupling was done by adding a connections.Model interface. This interface is effectively an extension of the protocol.Model interface that also handles connections alongside the modified service. 2015-09-23 13:03:36 -07:00			`return w.writer.Write(buf)`
Rate limit sent data, not uncompressed 2014-04-01 11:36:54 -07:00			`}`