# limitreader

**Repository Path**: setriones/limitreader

## Basic Information

- **Project Name**: limitreader
- **Description**: No description available
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# A golang limit timed reader

It generates output either buffer is full or time interval is reached.

## Installation

go get -d -v github.com/SeTriones/limitreader

## Example

```go
package main

import (
	"github.com/SeTriones/limitreader"
)

func main() {
	// the first paramter is max queue size;
	// the second is output buf size;
	// the third is time interval (in milliseocnds.)
	// reader will transfer its input items to output either on: 
	// a) queue has items more than buf size;
	// b) time passes interval milliseocnds since last transfer;
	r := NewReader(100000, 200, 50)

	// output is a readonly channel for consumers to read
	output := r.GetOutput()	

	for i := 0; i < 5; i++ {
		go func(r *Reader) {
			for values := range output {
				// your code here
			}
		}(r)
	}		

	for i := 0; i < 100000; i++ {
		r.Put(i)
	}
}
```