sns

Documentation

Index

• Variables
• func NewPartialBASE64Topic(topicARN string, opts ...Option) (msg.Topic, error)
• func NewTopic(topicARN string, opts ...Option) (msg.Topic, error)
• func NewUnencodedTopic(topicARN string, opts ...Option) (msg.Topic, error)
• type BatchedTopic
  • func NewBatchedTopic(topicARN string, timeout ...time.Duration) (BatchedTopic, error)
• type BatchedTopicS
• type MessageWriter
  • func (w *MessageWriter) Attributes() *msg.Attributes
  • func (w *MessageWriter) Close() error
  • func (w *MessageWriter) Write(p []byte) (int, error)
• type Option
  • func WithCustomRetryer(r request.Retryer) Option
  • func WithRetries(delay time.Duration, max int) Option
• type Topic
  • func (t *Topic) NewWriter(ctx context.Context) msg.MessageWriter

Variables

var NewSNSPublisherFunc = func(sess *session.Session, cfgs ...*aws.Config) awsinterfaces.SNSPublisher {
	if len(cfgs) == 0 {
		return sns.New(sess)
	} else {
		return sns.New(sess, cfgs...)
	}
}

DI to support mocking

Functions

func NewPartialBASE64Topic

func NewPartialBASE64Topic(topicARN string, opts ...Option) (msg.Topic, error)

NewPartialBASE64Topic returns a sns.Topic with fully configured SNSAPI.

Note: SQS has limited support for unicode characters. - See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html Because we use SNS and SQS together, we recommend that SNS messages are *partially* base64-encoded: only the unicode fragments not supported by SQS are encoded. You may use NewUnencodedTopic if you wish to ignore the encoding step.

func NewTopic

func NewTopic(topicARN string, opts ...Option) (msg.Topic, error)

NewTopic returns a sns.Topic with fully configured SNSAPI.

Note: SQS has limited support for unicode characters. - See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html Because we use SNS and SQS together, we recommend that SNS messages are base64-encoded as a best practice. You may use NewUnencodedTopic if you wish to ignore the encoding step.

func NewUnencodedTopic

func NewUnencodedTopic(topicARN string, opts ...Option) (msg.Topic, error)

NewUnencodedTopic creates an concrete SNS msg.Topic

Messages published by the `Batcher` returned will not have the body base64-encoded.

Types

type BatchedTopic

type BatchedTopic interface {
	msg.Topic
	batching.Batcher
}

NewBatchedTopic creates an concrete SNS msg.Topic It returns msg.Topic as opposed to BatchedTopic so that existing calls to NewTopic could simply replace it with NewBatchedTopic Messages published by the `Batcher` returned will be partially base64-encoded: only runes SQS does not support will be encoded. And these messages will be batched for transmission.

func NewBatchedTopic

func NewBatchedTopic(topicARN string, timeout ...time.Duration) (BatchedTopic, error)

type BatchedTopicS

type BatchedTopicS struct {
	msg.Topic
	batching.Batcher
}

type MessageWriter

type MessageWriter struct {
	msg.MessageWriter
	// contains filtered or unexported fields
}

MessageWriter writes data to an output SNS batcher as configured via its topicARN.

func (*MessageWriter) Attributes

func (w *MessageWriter) Attributes() *msg.Attributes

Attributes returns the msg.Attributes associated with the MessageWriter.

func (*MessageWriter) Close

func (w *MessageWriter) Close() error

Close converts the MessageWriter's Body and Attributes to sns.PublishInput in order to publish itself to the MessageWriter's snsClient.

On the first call to Close, the MessageWriter is set to "isClosed" therefore blocking subsequent Close and Write calls.

func (*MessageWriter) Write

func (w *MessageWriter) Write(p []byte) (int, error)

Write writes data to the MessageWriter's internal buffer for aggregation before a .Close()

After a MessageWriter's .Close() method has been called, it is no longer available for .Write() calls.

type Option

type Option func(*Topic) error

Option is the signature that modifies a `Batcher` to set some configuration

func WithCustomRetryer

func WithCustomRetryer(r request.Retryer) Option

WithCustomRetryer sets a custom `Retryer` to use on the SQS client.

func WithRetries

func WithRetries(delay time.Duration, max int) Option

WithRetries makes the `Server` retry on credential errors until `max` attempts with `delay` seconds between requests. This is needed in scenarios where credentials are automatically generated and the program starts before AWS finishes propagating them

type Topic

type Topic struct {
	Svc      awsinterfaces.SNSPublisher
	TopicARN string

	Batcher batching.Batcher
	// contains filtered or unexported fields
}

Topic configures and manages SNSAPI for sns.MessageWriter.

func (*Topic) NewWriter

func (t *Topic) NewWriter(ctx context.Context) msg.MessageWriter

NewWriter returns a sns.MessageWriter instance for writing to the configured SNS Topic.