Documentation
¶
Index ¶
- Constants
- Variables
- func SetManager(ctx context.Context, inst Manager) (context.Context, error)
- func SetManagerIfAbsent(ctx context.Context, inst Manager) (context.Context, error)
- func WithManager(ctx context.Context, fn func(Manager))
- type CallbackFn
- type Config
- type Manager
- type Process
- func (p *Process) Context() context.Context
- func (p *Process) Invoke(event events.Event) events.Event
- func (p *Process) Name() string
- func (p *Process) Query(arg any) any
- func (p *Process) RespondsTo(event events.Event) bool
- func (p *Process) Run() bool
- func (p *Process) Running() bool
- func (p *Process) Stop() bool
- func (p *Process) Type() string
- type QueryFn
- type State
- type StopAllResults
Constants ¶
const ContextKeyManager = "gohacks/process@v1"
Key used to store the instance in the context's user value.
Variables ¶
var ErrValueNotManager = errors.Base("value is not Manager")
Signalled if the instance associated with the context key is not of type Manager.
Functions ¶
func SetManager ¶ added in v1.0.6
Set Manager stores the instance in the context map.
func SetManagerIfAbsent ¶ added in v1.0.6
SetManagerIfAbsent sets only if not already present.
func WithManager ¶ added in v1.0.6
WithManager calls fn with the instance or fallback.
Types ¶
type Config ¶
type Config struct {
Name string // Pretty name.
Interval types.Duration // `RunEvery` time interval.
Function CallbackFn // `Action` callback.
OnStart CallbackFn // `Start` callback.
OnStop CallbackFn // `Stop` callback.
OnQuery QueryFn // `Query` callback.
Responder responder.Respondable // Responder object.
}
Process configuration structure.
type Manager ¶
type Manager interface {
Logger() logger.Logger
SetContext(context.Context)
SetLogger(logger.Logger)
Context() context.Context
Create(*Config) *Process
Add(*Process)
Find(string) (*Process, bool)
Run(string) bool
Stop(string) bool
StopAll() StopAllResults
Processes() []*Process
Count() int
}
Process manager structure.
To use,
1) Create a new process manager:
```go
procmgr := process.NewManager()
```
2) Create your process configuration:
```go
conf := &process.Config{
Name: "Windows 95",
Interval: 10, // seconds
Function: func(state *State) {
// Crash or something.
}
}
```
3) Create the process itself.
```go
proc := procmgr.Create(conf)
```
4) Run the process.
```go
procmgr.Run("Windows 95")
```
/or/
```go
proc.Run()
```
Manager is optional, as you can create processes directly.
func FromManager ¶ added in v1.0.6
FromManager returns the instance or the fallback.
func GetManager ¶ added in v1.0.6
Get the logger from the given context.
Will return ErrValueNotManager if the value in the context is not of type Manager.
func MustGetManager ¶ added in v1.0.6
Attempt to get the instance from the given context. Panics if the operation fails.
func NewManagerWithContext ¶
Create a new process manager with a given parent context.
type Process ¶
type Process struct {
// contains filtered or unexported fields
}
Process structure.
To use:
1) Create a config:
```go
conf := &process.Config{
Name: "Windows 95",
Interval: 10, // 10 seconds.
Function: func(state *State) {
// Crash or something.
},
}
```
2) Create a process:
```go
proc := process.NewProcess(conf)
```
3) Run the process:
```go
go proc.Run()
```
4) Send data to the process:
```go
proc.Send("Blue Screen of Death")
```
5) Read data from the process:
```go
data := proc.Receive()
```
6) Stop the process
```go
proc.Stop()
```
will stop the process.
func NewProcess ¶
Create a new process with the given configuration.
func NewProcessWithContext ¶
Create a new process with the given configuration and parent context.
func (*Process) Query ¶ added in v0.1.1
Query the running process.
This allows interaction with the process's base object without using `Action`.
func (*Process) Run ¶
Run the process with its action taking place on a continuous loop.
Returns 'true' if the process has been started, or 'false' if it is already running.
type State ¶
type State struct {
// contains filtered or unexported fields
}
Internal state for processes.
Source Files