gls

README

Goroutine local storage

Experimental Goroutine local storage using GoRoutine address as the ID library for golang.

Documentation

Index

• func Cleanup()
• func Get(key string) interface{}
• func Go(f func())
• func Set(key string, value interface{})
• func With(values Storage, f func())
• type Storage
  • func Put(timeout time.Duration) Storage

Functions

func Cleanup

func Cleanup()

Cleanup removes all data associated with this goroutine. If this is not called, the data may persist for the lifetime of your application. This must be called from the very first goroutine to invoke Set

func Get

func Get(key string) interface{}

Get gets the value by key as it exists for the current goroutine.

func Go

func Go(f func())

Go creates a new goroutine and runs the provided function in that new goroutine. It also associates any key,value pairs stored for the parent goroutine with the child goroutine. This function must be used if you wish to preserve the reference to any data stored in gls. This function automatically cleans up after itself. Do not call cleanup in the function passed to this function.

func Set

func Set(key string, value interface{})

Set sets the value by key and associates it with the current goroutine.

func With

func With(values Storage, f func())

With is a convenience function that stores the given values on this goroutine, calls the provided function (which will have access to the values) and then cleans up after itself.

Types

type Storage

type Storage map[string]interface{}

Storage the current goroutine local storage

func Put

func Put(timeout time.Duration) Storage

Put return a new map instance for current goroutine, it will store a global map and delete after `timeout` Duration