The highest tagged major version is
Documentation
¶
Overview ¶
Package queue provides SQS queue manipulations on the top of stripe/aws-go.
Index ¶
- func BuildBatchRequestEntry(messages ...BatchMessage) ([]*sqs.SendMessageBatchRequestEntry, map[string]int)
- func GetQueueURL(s sqsiface.SQSAPI, name string) (*string, error)
- func NewBatchError(id2index map[string]int, errors []*sqs.BatchResultErrorEntry) error
- type BatchChangeMessageVisibility
- type BatchError
- type BatchMessage
- type Queue
- func (q *Queue) ChangeMessageVisibility(receiptHandle *string, visibilityTimeout int64) error
- func (q *Queue) ChangeMessageVisibilityBatch(opts ...BatchChangeMessageVisibility) error
- func (q *Queue) DeleteMessage(receiptHandle *string) error
- func (q *Queue) DeleteMessageBatch(receiptHandles ...*string) error
- func (q *Queue) DeleteQueue() error
- func (q *Queue) PurgeQueue() error
- func (q *Queue) ReceiveMessage(opts ...option.ReceiveMessageInput) ([]*sqs.Message, error)
- func (q *Queue) SendMessage(body string, opts ...option.SendMessageInput) (*sqs.SendMessageOutput, error)
- func (q *Queue) SendMessageBatch(messages ...BatchMessage) error
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildBatchRequestEntry ¶
func BuildBatchRequestEntry(messages ...BatchMessage) ([]*sqs.SendMessageBatchRequestEntry, map[string]int)
BuildBatchRequestEntry builds batch entries and id2index map.
func GetQueueURL ¶
GetQueueURL returns a URL for the given queue name.
func NewBatchError ¶
func NewBatchError(id2index map[string]int, errors []*sqs.BatchResultErrorEntry) error
NewBatchError composes an error from errors if available.
Types ¶
type BatchChangeMessageVisibility ¶
A BatchChangeMessageVisibility represents each request to change a visibility timeout.
type BatchError ¶
A BatchError represents an error for batch operations such as SendMessageBatch and ChangeMessageVisibilityBatch. Index can be used to identify a message causing the error. See SendMessageBatch how to handle an error in batch operation.
func IsBatchError ¶
func IsBatchError(err error) (errors []*BatchError, ok bool)
IsBatchError checks that err contains BatchError. If err contains BatchError, it returns []*BatchError, true. If not, it returns nil, false.
func (*BatchError) Error ¶
func (e *BatchError) Error() string
type BatchMessage ¶
type BatchMessage struct {
Body string
Options []option.SendMessageInput
}
A BatchMessage represents each request to send a message. Options are used to change parameters for the message.
type Queue ¶
A Queue is an SQS queue which holds queue url in URL. Queue allows you to call actions without queue url for every call.
func (*Queue) ChangeMessageVisibility ¶
ChangeMessageVisibility changes a message visibiliy timeout.
func (*Queue) ChangeMessageVisibilityBatch ¶
func (q *Queue) ChangeMessageVisibilityBatch(opts ...BatchChangeMessageVisibility) error
ChangeMessageVisibilityBatch changes a visibility timeout for each message in opts.
func (*Queue) DeleteMessage ¶
DeleteMessage deletes a message from SQS queue.
func (*Queue) DeleteMessageBatch ¶
DeleteMessageBatch deletes messages from SQS queue.
func (*Queue) PurgeQueue ¶
PurgeQueue purges messages in SQS queue. It deletes all messages in SQS queue.
func (*Queue) ReceiveMessage ¶
ReceiveMessage receives messages from SQS queue. opts are used to change parameters for a request.
func (*Queue) SendMessage ¶
func (q *Queue) SendMessage(body string, opts ...option.SendMessageInput) (*sqs.SendMessageOutput, error)
SendMessage sends a message to SQS queue. opts are used to change parameters for a message.
Example ¶
package main
import (
"log"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sqs"
"github.com/nabeken/aws-go-sqs/queue"
"github.com/nabeken/aws-go-sqs/queue/option"
)
func main() {
// Create SQS instance
s := sqs.New(session.Must(session.NewSession()))
// Create Queue instance
q, err := queue.New(s, "example-queue-name")
if err != nil {
log.Fatal(err)
}
// MessageAttributes
attrs := map[string]interface{}{
"ATTR1": "STRING!!",
"ATTR2": 12345,
}
if _, err := q.SendMessage("MESSAGE BODY", option.MessageAttributes(attrs)); err != nil {
log.Fatal(err)
}
log.Print("successed!")
}
Output:
func (*Queue) SendMessageBatch ¶
func (q *Queue) SendMessageBatch(messages ...BatchMessage) error
SendMessageBatch sends messages to SQS queue.
Example ¶
package main
import (
"log"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sqs"
"github.com/nabeken/aws-go-sqs/queue"
"github.com/nabeken/aws-go-sqs/queue/option"
)
func main() {
// Create SQS instance
s := sqs.New(session.Must(session.NewSession()))
// Create Queue instance
q, err := queue.New(s, "example-queue-name")
if err != nil {
log.Fatal(err)
}
// MessageAttributes
attrs := map[string]interface{}{
"ATTR1": "STRING!!",
}
// Create messages for batch operation
batchMessages := []queue.BatchMessage{
queue.BatchMessage{
Body: "success",
},
queue.BatchMessage{
Body: "failed",
Options: []option.SendMessageInput{option.MessageAttributes(attrs)},
},
}
err = q.SendMessageBatch(batchMessages...)
if err != nil {
batchErrors, ok := queue.IsBatchError(err)
if !ok {
log.Fatal(err)
}
for _, e := range batchErrors {
if e.SenderFault {
// Continue if the failure is on the client side.
log.Print(e)
continue
}
// Retry if the failure is on the server side
// You can use e.Index to identify the message
// failedMessage := batchMessages[e.Index]
}
}
}
Output:
Source Files
Directories