Documentation
¶
Index ¶
- type Client
- func (client *Client) Close(ctx context.Context) error
- func (client *Client) CreateQueue(ctx context.Context, meta schema.Queue) (*schema.Queue, error)
- func (client *Client) CreateTask(ctx context.Context, queue string, meta schema.TaskMeta) (*schema.Task, error)
- func (client *Client) CreateTicker(ctx context.Context, meta schema.TickerMeta) (*schema.Ticker, error)
- func (client *Client) DeleteQueue(ctx context.Context, name string) (*schema.Queue, error)
- func (client *Client) DeleteTicker(ctx context.Context, name string) (*schema.Ticker, error)
- func (client *Client) FailTask(ctx context.Context, task uint64, result any, status *string) (*schema.Task, error)
- func (client *Client) GetQueue(ctx context.Context, name string) (*schema.Queue, error)
- func (client *Client) GetTask(ctx context.Context, task uint64, status *string) (*schema.Task, error)
- func (client *Client) GetTicker(ctx context.Context, name string) (*schema.Ticker, error)
- func (client *Client) ListQueues(ctx context.Context, req schema.QueueListRequest) (*schema.QueueList, error)
- func (client *Client) ListTickers(ctx context.Context, req schema.TickerListRequest) (*schema.TickerList, error)
- func (client *Client) NextTask(ctx context.Context) (*schema.Task, error)
- func (client *Client) NextTicker(ctx context.Context) (*schema.Ticker, error)
- func (client *Client) RegisterQueue(ctx context.Context, meta schema.Queue) (*schema.Queue, error)
- func (client *Client) RegisterTicker(ctx context.Context, meta schema.TickerMeta) (*schema.Ticker, error)
- func (client *Client) ReleaseTask(ctx context.Context, task uint64, result any) (*schema.Task, error)
- func (client *Client) RunTaskLoop(ctx context.Context, taskch chan<- *schema.Task, errch chan<- error) error
- func (client *Client) RunTickerLoop(ctx context.Context, ch chan<- *schema.Ticker) error
- func (client *Client) UpdateQueue(ctx context.Context, name string, meta schema.Queue) (*schema.Queue, error)
- func (client *Client) UpdateTicker(ctx context.Context, name string, meta schema.TickerMeta) (*schema.Ticker, error)
- func (client *Client) Worker() string
- type Opt
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) CreateQueue ¶
CreateQueue creates a new queue, and returns it.
func (*Client) CreateTask ¶
func (client *Client) CreateTask(ctx context.Context, queue string, meta schema.TaskMeta) (*schema.Task, error)
CreateTask creates a new task, and returns it.
func (*Client) CreateTicker ¶
func (client *Client) CreateTicker(ctx context.Context, meta schema.TickerMeta) (*schema.Ticker, error)
CreateTicker creates a new ticker, and returns it.
func (*Client) DeleteQueue ¶
DeleteQueue deletes a queue with the given name, and returns the deleted queue.
func (*Client) DeleteTicker ¶
DeleteTicker deletes an existing ticker, and returns the deleted ticker.
func (*Client) FailTask ¶
func (client *Client) FailTask(ctx context.Context, task uint64, result any, status *string) (*schema.Task, error)
FailTask fails a task, either for retry or permanent failure, and returns the task and status.
func (*Client) GetTask ¶
func (client *Client) GetTask(ctx context.Context, task uint64, status *string) (*schema.Task, error)
GetTask returns a task based on identifier, and optionally sets the task status.
func (*Client) ListQueues ¶
func (client *Client) ListQueues(ctx context.Context, req schema.QueueListRequest) (*schema.QueueList, error)
ListQueues returns all queues as a list
func (*Client) ListTickers ¶
func (client *Client) ListTickers(ctx context.Context, req schema.TickerListRequest) (*schema.TickerList, error)
ListTickers returns all tickers in a namespace as a list
func (*Client) NextTask ¶
NextTask retains a task, and returns it. Returns nil if there is no task to retain
func (*Client) NextTicker ¶
NextTicker returns the next matured ticker, or nil
func (*Client) RegisterQueue ¶
RegisterQueue creates a new queue, or updates an existing queue, and returns it.
func (*Client) RegisterTicker ¶
func (client *Client) RegisterTicker(ctx context.Context, meta schema.TickerMeta) (*schema.Ticker, error)
RegisterTicker creates a new ticker, or updates an existing ticker, and returns it.
func (*Client) ReleaseTask ¶
func (client *Client) ReleaseTask(ctx context.Context, task uint64, result any) (*schema.Task, error)
ReleaseTask releases a task from a queue, and returns it.
func (*Client) RunTaskLoop ¶
func (client *Client) RunTaskLoop(ctx context.Context, taskch chan<- *schema.Task, errch chan<- error) error
RunTaskLoop runs a loop to process matured tasks, until the context is cancelled. It does not retain or release tasks, but simply returns them to the caller.
func (*Client) RunTickerLoop ¶
RunTickerLoop runs a loop to process matured tickers, until the context is cancelled.
func (*Client) UpdateQueue ¶
func (client *Client) UpdateQueue(ctx context.Context, name string, meta schema.Queue) (*schema.Queue, error)
UpdateQueue updates an existing queue with the given name, and returns the queue.