goper

README

goper

---

Goper is wrapped a goroutine and channal structure, it's safety to close goroutine and channal after handle all task, witch had putting into channal.

---

使用说明

• frist, import goper into code: import github/min1324/goper

• use Default to run.

• use Deliver(arg), send arg to handle.

• finally,Close() to release and exit goroutine.

API

type Handler func(interface{})
Close()
Default(maxGo int, hd Handler) error
Deliver(arg interface{}) error

使用示例

package main

import (
	"fmt"
	"github/min1324/goper"
)

func main() {
	var g goper.Goper
	g.Default(1, Router)
	defer g.Close()

	g.Deliver("hello world.")
}

func Router(i interface{}) {
	s, ok := i.(string)
	if ok {
		fmt.Println(s)
	}
}

Documentation

Index

• type Function
• type Goper
  • func (g *Goper) Close()
  • func (g *Goper) Default(maxGo int, hd Handler) error
  • func (g *Goper) Deliver(arg interface{}) error
  • func (g *Goper) Name(name string)
  • func (g *Goper) Put(arg interface{}) error
  • func (g *Goper) String() string
• type Handler
• type Pool
  • func (mgr *Pool) Close(name string)
  • func (p *Pool) Default(name string, maxgo int, hd Handler) error
  • func (p *Pool) Get(name string) (t Worker, ok bool)
  • func (p *Pool) Groud(name string, maxgo int) error
  • func (mgr *Pool) GroupPut(name string, fn Function) error
  • func (mgr *Pool) Put(name string, arg interface{}) error
  • func (p *Pool) Register(name string, w Worker) error
  • func (mgr *Pool) Shutdown()
• type Worker
  • func New(hd Handler) Worker

Types

type Function

type Function func()

Function a func type for group.

type Goper

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

Goper a simple half sync half async goroutine pool.

equire to go func(). Goper is safety to close all goroutine before done the task using Put() to channal.

func (*Goper) Close

func (g *Goper) Close()

Close() stop runner, wait for all work and goroutine finish.

func (*Goper) Default

func (g *Goper) Default(maxGo int, hd Handler) error

Default run maxGo num of goroutine. if maxGo<1, it will use numcpu.

func (*Goper) Deliver

func (g *Goper) Deliver(arg interface{}) error

Deliver send an arg to handler, if Goper not run, it return an error.

func (*Goper) Name

func (g *Goper) Name(name string)

Name register Goper name.

func (*Goper) Put

func (g *Goper) Put(arg interface{}) error

Put implicate Worker.

func (*Goper) String

func (g *Goper) String() string

String get Goper name.

type Handler

type Handler func(interface{})

Handler user handler fuction type.

type Pool

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

Pool goper pool

func (*Pool) Close

func (mgr *Pool) Close(name string)

Close stop name's worker.

func (*Pool) Default

func (p *Pool) Default(name string, maxgo int, hd Handler) error

Default Register a Worker run in default mode.

func (*Pool) Get

func (p *Pool) Get(name string) (t Worker, ok bool)

Get return name's Worker.

func (*Pool) Groud

func (p *Pool) Groud(name string, maxgo int) error

Groud Register a group. send to group's arg must be Function.

func (*Pool) GroupPut

func (mgr *Pool) GroupPut(name string, fn Function) error

GroupPut send i to name's group.

func (*Pool) Put

func (mgr *Pool) Put(name string, arg interface{}) error

Put send i to name's worker or group. if to group,arg must be Function type.

func (*Pool) Register

func (p *Pool) Register(name string, w Worker) error

Register put Worker into pool.

func (*Pool) Shutdown

func (mgr *Pool) Shutdown()

Shutdown stop all in pool.

type Worker

type Worker interface {
	Close()
	Put(arg interface{}) error
	String() string
}

Worker gopool interface.

func New

func New(hd Handler) Worker

New return an Goper using default.