buflice

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2019 License: MIT Imports: 2 Imported by: 0

README

buflice

This package need to create buffered slice that can be flushed when reach size or duration limit

When it can be needed?

Example: You have a worker for rabbitmq that receives jobs from queue. You receive them one by one and process it. But sometimes you need to accumulate data from jobs for batch processing in database.

Website | Blog

license GoDoc Coverage Status Build Status Go Report Card

Installation

go get -u github.com/riftbit/buflice

Example


package main

import (
	"log"
	"sync"
	"testing"
	"time"

	"github.com/riftbit/buflice"
)

var bfl *buflice.Buflice
var chDone chan bool
var chFlush chan []interface{}
var wgWait sync.WaitGroup

func flushProcessor() {
	for {
		select {
		case data := <-chFlush:
			log.Println(data)
		case <-chDone:
			wgWait.Done()
			log.Println("Finished flushProcessor")
			return
		}
	}
}

func main() {
	chDone = make(chan bool)
	chFlush = make(chan []interface{})

	wgWait.Add(1)

	bfl = buflice.NewBuflice(6, 5*time.Second, chFlush)
	go flushProcessor()

	bfl.Add("Record #1")
	bfl.Add("Record #2")
	bfl.Add("Record #3")
	bfl.Add("Record #4")
	bfl.Add("Record #5")
	bfl.Add("Record #6")
	bfl.Add("Record #7")
	bfl.Add("Record #8")
	bfl.Add("Record #9")
	bfl.Add("Record #10")

	bfl.Flush()

    chDone <- true
	wgWait.Wait()
	err := bfl.Close()
	if err != nil {
		log.Fatalln(err)
	}

}

Will print:

2019/09/03 14:56:28 [Record #1 Record #2 Record #3 Record #4 Record #5 Record #6]
2019/09/03 14:56:28 [Record #7 Record #8 Record #9 Record #10]
2019/09/03 14:56:28 Finished flushProcessor

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Buflice

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

Buflice main struct that contains configs and methods

func NewBuflice

func NewBuflice(size int, flushDuration time.Duration, notifyChannel chan []interface{}) *Buflice

NewBuflice method to initiate Buflice and get it

func (*Buflice) Add

func (bs *Buflice) Add(element interface{})

Add is for adding elements

func (*Buflice) Close

func (bs *Buflice) Close() error

Close is for close time ticker, clean slice data and slice position

func (*Buflice) Flush

func (bs *Buflice) Flush()

Flush is for flush data to channel

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL