sqs

Documentation

Index

• Constants
• func New(queue string, opts ...Option) (*kernel.Kernel, error)
• func NewDequeuer(queue string, opts ...Option) (*kernel.Dequeuer, error)
• func NewEnqueuer(queue string, opts ...Option) (*kernel.Enqueuer, error)
• type Client
  • func (cli *Client) Ack(ctx context.Context, digest string) error
  • func (cli Client) Ask(ctx context.Context) ([]swarm.Bag, error)
  • func (cli *Client) Enq(ctx context.Context, bag swarm.Bag) error
  • func (cli *Client) Err(ctx context.Context, digest string, err error) error
• type Option
  • func WithBatchSize(batch int) Option
  • func WithConfig(opts ...swarm.Option) Option
  • func WithService(service SQS) Option
• type SQS

Constants

const EnvConfigSourceSQS = "CONFIG_SWARM_SOURCE_SQS"

Environment variable to config event source

const Version = "broker/sqs/v0.20.2"

Functions

func New

func New(queue string, opts ...Option) (*kernel.Kernel, error)

Create enqueue & dequeue routine to AWS SQS

func NewDequeuer

func NewDequeuer(queue string, opts ...Option) (*kernel.Dequeuer, error)

Create dequeue routine to AWS SQS

func NewEnqueuer

func NewEnqueuer(queue string, opts ...Option) (*kernel.Enqueuer, error)

Create enqueue routine to AWS SQS

Types

type Client

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

func (*Client) Ack

func (cli *Client) Ack(ctx context.Context, digest string) error

func (Client) Ask

func (cli Client) Ask(ctx context.Context) ([]swarm.Bag, error)

Deq dequeues message from broker

func (*Client) Enq

func (cli *Client) Enq(ctx context.Context, bag swarm.Bag) error

Enq enqueues message to broker

func (*Client) Err

func (cli *Client) Err(ctx context.Context, digest string, err error) error

type Option

type Option func(*Client)

func WithBatchSize

func WithBatchSize(batch int) Option

Configure's SQS batch size. Note: AWS SQS limits the MaxNumberOfMessages to 10 per poller. This config increases number of poller

func WithConfig

func WithConfig(opts ...swarm.Option) Option

Global "kernel" configuration.

func WithService

func WithService(service SQS) Option

Passes AWS SQS client instance to broker

type SQS

type SQS interface {
	GetQueueUrl(context.Context, *sqs.GetQueueUrlInput, ...func(*sqs.Options)) (*sqs.GetQueueUrlOutput, error)
	SendMessage(context.Context, *sqs.SendMessageInput, ...func(*sqs.Options)) (*sqs.SendMessageOutput, error)
	ReceiveMessage(context.Context, *sqs.ReceiveMessageInput, ...func(*sqs.Options)) (*sqs.ReceiveMessageOutput, error)
	DeleteMessage(context.Context, *sqs.DeleteMessageInput, ...func(*sqs.Options)) (*sqs.DeleteMessageOutput, error)
}

SQS