sqs

Documentation

Index

• type Client
• type Publisher
  • func NewPublisher(ctx context.Context, svc Client, queue string, opts ...PublisherOption) (*Publisher, error)
  • func NewPublisherFromDefault(ctx context.Context, queue string, opts ...PublisherOption) (*Publisher, error)
  • func (p Publisher) Publish(ctx context.Context, msg messenger.Message) error
• type PublisherOption
  • func PublisherWithDefaultOrderingKey(key string) PublisherOption
  • func PublisherWithFifoQueue(fifo bool) PublisherOption
  • func PublisherWithMessageIDKey(key string) PublisherOption
  • func PublisherWithMetaOrderingKey(key string) PublisherOption
• type Subscriber
  • func NewSubscriber(cli Client, opts ...SubscriberOption) *Subscriber
  • func NewSubscriberFromDefault(ctx context.Context, queue string, opts ...SubscriberOption) (*Subscriber, error)
  • func (s *Subscriber) Listen(ctx context.Context) error
  • func (s *Subscriber) Register(subs ...messenger.Subscription)
• type SubscriberOption
  • func SubscriberWithMaxMessages(msgs int) SubscriberOption
  • func SubscriberWithMaxWaitSeconds(waitSec int) SubscriberOption
  • func SubscriberWithMessageIDKey(key string) SubscriberOption

Types

type Client

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

Client defines the AWS SQS methods used by the Publisher. This is used for testing purposes.

type Publisher

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

Publisher handles the pubsub topic messages.

func NewPublisher

func NewPublisher(ctx context.Context, svc Client, queue string, opts ...PublisherOption) (*Publisher, error)

NewPublisher returns a new Publisher instance.

func NewPublisherFromDefault

func NewPublisherFromDefault(ctx context.Context, queue string, opts ...PublisherOption) (*Publisher, error)

NewPublisherFromDefault returns a new Publisher instance.

func (Publisher) Publish

func (p Publisher) Publish(ctx context.Context, msg messenger.Message) error

Publish publishes the given message to the pubsub topic.

type PublisherOption

type PublisherOption func(*Publisher)

PublisherOption is a function to set options to Publisher.

func PublisherWithDefaultOrderingKey

func PublisherWithDefaultOrderingKey(key string) PublisherOption

PublisherWithDefaultOrderingKey setups the default ordering key.

func PublisherWithFifoQueue

func PublisherWithFifoQueue(fifo bool) PublisherOption

PublisherWithFifoQueue setups the flag to use fifo queue.

func PublisherWithMessageIDKey

func PublisherWithMessageIDKey(key string) PublisherOption

PublisherWithMessageIDKey modify default message id key.

func PublisherWithMetaOrderingKey

func PublisherWithMetaOrderingKey(key string) PublisherOption

PublisherWithMetaOrderingKey setups the metadata key to get the ordering key.

type Subscriber

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

Subscriber registers subscriptions to AWS SQS.

func NewSubscriber

func NewSubscriber(cli Client, opts ...SubscriberOption) *Subscriber

NewSubscriber returns a new Publisher instance.

func NewSubscriberFromDefault

func NewSubscriberFromDefault(ctx context.Context, queue string, opts ...SubscriberOption) (*Subscriber, error)

NewSubscriberFromDefault returns a new Publisher instance.

func (*Subscriber) Listen

func (s *Subscriber) Listen(ctx context.Context) error

Listen starts listening for events.

func (*Subscriber) Register

func (s *Subscriber) Register(subs ...messenger.Subscription)

Register adds subscriptions to subscriber.

type SubscriberOption

type SubscriberOption func(*Subscriber)

SubscriberOption is a function to set options to Subscriber.

func SubscriberWithMaxMessages

func SubscriberWithMaxMessages(msgs int) SubscriberOption

SubscriberWithMaxMessages replaces default number of messages to receive.

func SubscriberWithMaxWaitSeconds

func SubscriberWithMaxWaitSeconds(waitSec int) SubscriberOption

SubscriberWithMaxWaitSeconds replaces default max time wait seconds.

func SubscriberWithMessageIDKey

func SubscriberWithMessageIDKey(key string) SubscriberOption

SubscriberWithMessageIDKey replaces default metadata key for id.