Debian Codegraph @

pubsub/rabbitpubsub/doc.go

raw
1 // Copyright 2018 The Go Cloud Development Kit Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 // Package rabbitpubsub provides an pubsub implementation for RabbitMQ.
16 // Use OpenTopic to construct a *pubsub.Topic, and/or OpenSubscription
17 // to construct a *pubsub.Subscription.
18 //
19 // RabbitMQ follows the AMQP specification, which uses different terminology
20 // than the Go CDK Pub/Sub.
21 //
22 // A Pub/Sub topic is an AMQP exchange. The exchange kind should be "fanout" to match
23 // the Pub/Sub model, although publishing will work with any kind of exchange.
24 //
25 // A Pub/Sub subscription is an AMQP queue. The queue should be bound to the exchange
26 // that is the topic of the subscription. See the package example for details.
27 //
28 // # URLs
29 //
30 // For pubsub.OpenTopic and pubsub.OpenSubscription, rabbitpubsub registers
31 // for the scheme "rabbit".
32 // The default URL opener will connect to a default server based on the
33 // environment variable "RABBIT_SERVER_URL".
34 // To customize the URL opener, or for more details on the URL format,
35 // see URLOpener.
36 // See https://gocloud.dev/concepts/urls/ for background information.
37 //
38 // # Message Delivery Semantics
39 //
40 // RabbitMQ supports at-least-once semantics; applications must
41 // call Message.Ack after processing a message, or it will be redelivered.
42 // See https://godoc.org/gocloud.dev/pubsub#hdr-At_most_once_and_At_least_once_Delivery
43 // for more background.
44 //
45 // # As
46 //
47 // rabbitpubsub exposes the following types for As:
48 // - Topic: *amqp.Connection
49 // - Subscription: *amqp.Connection
50 // - Message.BeforeSend: *amqp.Publishing
51 // - Message.AfterSend: None
52 // - Message: amqp.Delivery
53 // - Error: *amqp.Error and MultiError
54 package rabbitpubsub // import "gocloud.dev/pubsub/rabbitpubsub"