README
¶
PHOS
You Can (Not) Redo
PHOS is a channel with internal handlers and diversified options.
Install
go get github.com/B1NARY-GR0UP/phos
Quick Start
package main
import (
"context"
"fmt"
"github.com/B1NARY-GR0UP/phos"
)
func hello(_ context.Context, data string) (string, error) {
return data + "-PHOS", nil
}
func main() {
ph := phos.New[string]()
defer ph.Close()
ph.Append(hello)
ph.In <- "BINARY"
res := <-ph.Out
ph.Delete(ph.Len() - 1)
fmt.Println(res.Data)
}
Configuration
| Option | Default | Description | Example |
|---|---|---|---|
WithContext |
context.Background() |
Set context for PHOS | example |
WithZero |
false |
Set zero value for return when error happened | example |
WithTimeout |
3 * time.Second |
Set timeout for handlers execution | example |
WithErrHandleFunc |
nil |
Set error handle function for PHOS which will be called when handle error happened | example |
WithErrTimeoutFunc |
nil |
Set error timeout function for PHOS which will be called when timeout error happened | example |
WithErrDoneFunc |
nil |
Set err done function for PHOS which will be called when context done happened | example |
Blogs
License
PHOS is distributed under the Apache License 2.0. The licenses of third party dependencies of PHOS are explained here.
ECOLOGY
PHOS is a Subproject of the Basic Middleware Service
Documentation
¶
Index ¶
Constants ¶
const ( Name = "PHOS" Version = "v0.3.3" )
BINARY-PHOS
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrDoneFunc ¶ added in v0.1.1
type ErrorType ¶
type ErrorType uint64
ErrorType for PHOS Error
const ( TimeoutErr ErrorType HandlerErr CtxErr )
type Option ¶
type Option func(o *Options)
Option for PHOS
func WithContext ¶
WithContext will set context for PHOS
func WithErrDoneFunc ¶ added in v0.1.1
func WithErrDoneFunc(fn ErrDoneFunc) Option
WithErrDoneFunc will set err done function for PHOS which will be called when ctx done happened Note: You should use it will WithContext, otherwise it will not work
func WithErrHandleFunc ¶
func WithErrHandleFunc(fn ErrHandleFunc) Option
WithErrHandleFunc will set error handle function for PHOS which will be called when handle error happened
func WithErrTimeoutFunc ¶
func WithErrTimeoutFunc(fn ErrTimeoutFunc) Option
WithErrTimeoutFunc will set error timeout function for PHOS which will be called when timeout error happened
func WithTimeout ¶
WithTimeout will set timeout for the handler chain execution (not just for each handler)
type Options ¶
type Options struct {
Ctx context.Context
Zero bool
Timeout time.Duration
ErrHandleFunc ErrHandleFunc
ErrTimeoutFunc ErrTimeoutFunc
ErrDoneFunc ErrDoneFunc
}
Options for PHOS
type Phos ¶
type Phos[T any] struct { In chan<- T Out <-chan Result[T] // contains filtered or unexported fields }
Phos short for Phosphophyllite PHOS is a channel with internal handler chain
func (*Phos[T]) Close ¶ added in v0.2.1
func (ph *Phos[T]) Close()
Close PHOS channel Note: You should not close In channel manually before or after calling Close
Source Files