timedbuf

README

Timed Buffer

Implementation of a buffer that flushes its' contents immediately when it's full or at regular intervals. This is useful if you have data that you need to buffer but don't want the items to stay in the buffer for too long.

Please note that in some cases it might be more efficient to use the actual data type (and buffer pools) instead of the generic interface{} type used in this implementation.

Usage

go get github.com/charithe/timedbuf

// define a flush function that will be called whenever the buffer is full or the time period has elapsed
func flushFunc(items []interface{}){
    // flush logic
}

// Initialize and use the buffer
tb := timedbuf.New(100, 10 * time.Second, flushFunc)
defer tb.Close()
tb.Put("foo", "bar")
tb.Put("baz")
...

Generics implementation

go get github.com/charithe/timedbuf/v2

// define a flush function that will be called whenever the buffer is full or the time period has elapsed
func flushFunc(items []string){
    // flush logic
}

// Initialize and use the buffer
tb := timedbuf.New(100, 10 * time.Second, flushFunc)
defer tb.Close()
tb.Put("foo", "bar")
tb.Put("baz")
...

Documentation

Overview

* Copyright 2016 Charith Ellawala * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• type TimedBuf
  • func New(size int, maxDelay time.Duration, flushFn func([]interface{})) *TimedBuf
  • func (tb *TimedBuf) Close()
  • func (tb *TimedBuf) Put(items ...interface{})

Types

type TimedBuf

type TimedBuf struct {
	// contains filtered or unexported fields
}

TimedBuf implements a buffer that gathers items until either the buffer size or a specified time limit is reached

func New

func New(size int, maxDelay time.Duration, flushFn func([]interface{})) *TimedBuf

func (*TimedBuf) Close

func (tb *TimedBuf) Close()

func (*TimedBuf) Put

func (tb *TimedBuf) Put(items ...interface{})