sns

Documentation

Index

• type Client
• type Option
  • func WithDefaultOrderingKey(key string) Option
  • func WithFifoQueue(fifo bool) Option
  • func WithMessageIDKey(key string) Option
  • func WithMetaOrderingKey(key string) Option
• type Publisher
  • func New(cli Client, topicARN string, opts ...Option) (*Publisher, error)
  • func Open(awsOpts sns.Options, topicARN string, opts ...Option) (*Publisher, error)
  • func (p Publisher) Publish(ctx context.Context, msg messenger.Message) error

Types

type Client

type Client interface {
	Publish(ctx context.Context, params *sns.PublishInput, optFns ...func(*sns.Options)) (*sns.PublishOutput, error)
}

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

type Option

type Option func(*Publisher)

Option is a function to set options to Publisher.

func WithDefaultOrderingKey

func WithDefaultOrderingKey(key string) Option

WithDefaultOrderingKey setups the default ordering key.

func WithFifoQueue

func WithFifoQueue(fifo bool) Option

WithFifoQueue setups the flag to use fifo queue.

func WithMessageIDKey

func WithMessageIDKey(key string) Option

WithMessageIDKey modify default message id key.

func WithMetaOrderingKey

func WithMetaOrderingKey(key string) Option

WithMetaOrderingKey setups the metadata key to get the ordering key.

type Publisher

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

Publisher handles the pubsub topic messages.

func New

func New(cli Client, topicARN string, opts ...Option) (*Publisher, error)

New returns a new Publisher instance.

func Open

func Open(awsOpts sns.Options, topicARN string, opts ...Option) (*Publisher, error)

Open 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.