Documentation
¶
Overview ¶
Package superbus provides an asynchronous task handler.
Index ¶
- func Marshal(v any) ([]byte, error)
- func Unmarshal(data []byte, v any) error
- func WithUnmarshall[T any](t *Task)
- type EagerEventManager
- type Event
- type EventHandler
- type EventManager
- type MemStore
- type Operation
- type Payload
- type RedisEventManager
- type RedisStore
- type Store
- type Task
- type TaskHandler
- type TaskManager
- type TaskManagerOption
- type TaskOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithUnmarshall ¶
WithUnmarshall registers a function that is responsible for payload decoding.
Types ¶
type EagerEventManager ¶
type EagerEventManager struct {
// contains filtered or unexported fields
}
EagerEventManager is a simple event manager using channels for event management.
func NewEagerEventManager ¶
func NewEagerEventManager() *EagerEventManager
NewEagerEventManager create an EagerEventManager instance.
func (*EagerEventManager) Listen ¶
func (m *EagerEventManager) Listen()
Listen listens for new events.
func (*EagerEventManager) On ¶
func (m *EagerEventManager) On(name string, f EventHandler)
On registers a event handler for a given event.
type Event ¶
Event is an event sent to the wire. It contains a name and a value that can be unmarshalled later.
type EventHandler ¶
type EventHandler func(Event)
EventHandler is a function that deals with an event.
type EventManager ¶
type EventManager interface {
// Listen starts listening to events
Listen()
// Stop stops the event listener
Stop()
// Push sends an event
Push(name string, value []byte) error
// On register a callaback for a specific event
On(name string, f EventHandler)
}
EventManager describes the methods implemented by an event manager.
type MemStore ¶
MemStore is a KvStore implementation using a simple in memory map.
type RedisEventManager ¶
type RedisEventManager struct {
// contains filtered or unexported fields
}
RedisEventManager is an event manager using redis as a message handler.
func NewRedisEventManager ¶
func NewRedisEventManager(rdc *redis.Client) *RedisEventManager
NewRedisEventManager creates a RedisEventManager instance.
func (*RedisEventManager) Listen ¶
func (m *RedisEventManager) Listen()
Listen listens for new events.
func (*RedisEventManager) On ¶
func (m *RedisEventManager) On(name string, f EventHandler)
On registers a event handler for a given event.
type RedisStore ¶
type RedisStore struct {
// contains filtered or unexported fields
}
RedisStore implements KvStore with redis.
func NewRedisStore ¶
func NewRedisStore(rdb *redis.Client, prefix string) *RedisStore
NewRedisStore returns a RedisStore instance. The prefix is used for each key operation.
func (*RedisStore) Get ¶
func (s *RedisStore) Get(key string) []byte
Get returns a value for the given key. Returns an empty string when the value does not exist.
type Store ¶
type Store interface {
Get(string) []byte
Set(string, []byte, time.Duration) error
Del(string) error
}
Store is a very basic key/value store.
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Task is a task shortcut.
type TaskHandler ¶
TaskHandler is the function called on a task.
type TaskManager ¶
TaskManager is the task manager.
func NewTaskManager ¶
func NewTaskManager(m EventManager, s Store, options ...TaskManagerOption) *TaskManager
NewTaskManager creates a new TaskManager instance.
func (*TaskManager) NewTask ¶
func (tm *TaskManager) NewTask(name string, options ...TaskOption) Task
NewTask creates a new Task instance.
func (*TaskManager) Register ¶
func (tm *TaskManager) Register(name string, f TaskHandler)
Register registers a task handler.
func (*TaskManager) Start ¶
func (tm *TaskManager) Start()
Start starts the events listener and the process workers.
func (*TaskManager) Stop ¶
func (tm *TaskManager) Stop()
Stop stops the event listener and wait for running tasks to finish.
type TaskManagerOption ¶
type TaskManagerOption func(*TaskManager)
TaskManagerOption is a function that sets TaskManager option upon creation.
func WithNumWorkers ¶
func WithNumWorkers(m int) TaskManagerOption
WithNumWorkers set the number of worker processes that handle operations.
func WithOperationPrefix ¶
func WithOperationPrefix(p string) TaskManagerOption
WithOperationPrefix sets a prefix for all operation payloads.
type TaskOption ¶
type TaskOption func(t *Task)
TaskOption is a function that sets Task option upon creation.
func WithTaskHandler ¶
func WithTaskHandler(f func(data any)) TaskOption
WithTaskHandler adds the given handler to the task.
Source Files