toolkit

README

toolkit

Introduction

These patterns can you use to solve common problems when designing an application or system.

Requirements

• golang >=1.11.x - The Go Programming Language

Installation

go get github.com/donutloop/toolkit/{any_package}

Example

go get github.com/donutloop/toolkit/worker

Patterns

• Worker
• Job schedule
• Singleton
• Retry
• Promise
• Multierror
• Loop
• Lease
• Event-system
• Debugutil
• Concurrent runner
• Bus-system

Examples

In each sub directory is a set of examples

Code generation

Currently, it's only compatiable with version 2.x.x

The code generation tool generates for a pattern an none generic version for spefici type

Supported pattern

• Worker

Build

mkdir -p $GOPATH/src/github.com/donutloop/ && cd $GOPATH/src/github.com/donutloop/

git clone git@github.com:donutloop/toolkit.git

cd toolkit

go install ./cmd/xcode

Usage

USAGE
  xcode [flags]

FLAGS
  -in     input file
  -out    output file
  -pkg    package name
  -type   type

Example generation

xcode -in $GOPATH/src/github.com/donutloop/toolkit/worker/worker.go -out $GOPATH/src/github.com/donutloop/toolkit/worker/new_worker.go -pkg test -type int32 

Example call for generated code

workerHandler := func(v int32) {
    fmt.Println(v)
}

queue := worker.New(2, workerHandler, 10)

queue <- int32(3)

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to toolkit, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please read and follow our Contributing.

Code of Conduct

Please read and follow our Code of Conduct.