Skip to content
A Broadway producer for Amazon SQS
Branch: master
Clone or download
Latest commit c36215b Feb 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
lib/broadway_sqs Update docs with BroadwaySQS.Producer Feb 18, 2019
test Update Broadway and adjust producer config (#7) Feb 18, 2019
.formatter.exs
.gitignore
.travis.yml Set up travis-ci (#2) Jan 18, 2019
CHANGELOG.md Release v0.1.0 Feb 19, 2019
README.md
mix.exs Run formatter Feb 19, 2019
mix.lock

README.md

BroadwaySQS

A AWS SQS connector for Broadway.

Documentation can be found at https://hexdocs.pm/broadway_sqs. For more details on using Broadway with Amazon SQS, please see the Amazon SQS Guide.

This project provides:

  • BroadwaySQS.Producer - A GenStage producer that continuously receives messages from a SQS queue and acknowledge them after being successfully processed.
  • BroadwaySQS.SQSClient - A generic behaviour to implement SQS clients.
  • BroadwaySQS.ExAwsClient - Default SQS client used by BroadwaySQS.Producer.

Installation

Add :broadway_sqs to the list of dependencies in mix.exs along with the HTTP client of your choice (defaults to :hackney):

def deps do
  [
    {:broadway_sqs, "~> 0.1.0"},
    {:hackney, "~> 1.9"}
  ]
end

Usage

Configure Broadway with one or more producers using BroadwaySQS.Producer:

Broadway.start_link(MyBroadway,
  name: MyBroadway,
  producers: [
    default: [
      module: {BroadwaySQS.Producer, queue_name: "my_queue"}
    ]
  ]
)

License

Copyright 2019 Plataformatec

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.