synceddata

README

synceddata

Package synceddata implements simple data types that are protected for concurrent use. Currently, the package only contains a simple Counter, but will be extended in the future.

Counter

Counter provides a simple counting interface that's made thread safe through use of a Mutex. Several methods are implemented to do typical functions.

Use:

include "fmt"
include "github.com/davexre/synceddata"

func main() {
	var myCounter synceddata.Counter

	myCounter.Incr()
	myCounter.Incr()
	myCounter.Decr()

	fmt.Printf("Who's number %!(NOVERB)v?\n", myCounter.Read())

	myCounter.Set(6)
	myCounter.Incr()

	fmt.Printf("%!(NOVERB)v is my lucky number!\n", myCounter.Read())
}

---

Readme created from Go doc with goreadme

Documentation

Overview

Package synceddata implements simple data types that are protected for concurrent use. Currently, the package only contains a simple Counter, but will be extended in the future.

Counter

Counter provides a simple counting interface that's made thread safe through use of a Mutex. Several methods are implemented to do typical functions.

Use:

include "fmt"
include "github.com/davexre/synceddata"

func main() {
	var myCounter synceddata.Counter

	myCounter.Incr()
	myCounter.Incr()
	myCounter.Decr()

	fmt.Printf("Who's number %v?\n", myCounter.Read())

	myCounter.Set(6)
	myCounter.Incr()

	fmt.Printf("%v is my lucky number!\n", myCounter.Read())
}

Index

• type Counter
  • func (c *Counter) Decr()
  • func (c *Counter) Incr()
  • func (c *Counter) Read() int
  • func (c *Counter) Set(i int)

Types

type Counter

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

Counter provides a simple counting interface that's made thread safe through use of a Mutex. Several methods are implemented to do typical functions.

func (*Counter) Decr

func (c *Counter) Decr()

func (*Counter) Incr

func (c *Counter) Incr()

func (*Counter) Read

func (c *Counter) Read() int

func (*Counter) Set

func (c *Counter) Set(i int)