Skip to content

Commit

Permalink
Fix comment formatting for godoc
Browse files Browse the repository at this point in the history
  • Loading branch information
tmdiep committed Dec 1, 2020
1 parent 68015cc commit c4987c0
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions pubsublite/ps/doc.go
Expand Up @@ -17,18 +17,21 @@ service that emulates the Cloud Pub/Sub API.
If interfaces are defined for pubsub.Topic.Publish() and
pubsub.Subscription.Receive(), the clients in this package can be used as
drop-in replacements. As noted in comments, the two services have some
differences:
drop-in replacements.
- Pub/Sub Lite does not support nack for messages. A custom function can be
provided for ReceiveSettings.NackHandler to handle nacked messages.
- Pub/Sub Lite has no concept of ack expiration. Subscribers must acknowledge
every message received or shut down the SubscriberClient.
- Pub/Sub Lite has publish and subscribe throughput limits. Thus publishing can
be more sensitive to buffer overflow.
- Pub/Sub Lite PublisherClients can terminate when an unretryable error occurs.
- DefaultPublishSettings and DefaultReceiveSettings should be used for default
settings rather than their empty types.
As noted in comments, the two services have some semantic differences:
- Pub/Sub Lite does not support nack for messages. A custom function can be
provided for ReceiveSettings.NackHandler to handle nacked messages.
- Pub/Sub Lite has no concept of ack expiration. Subscribers must acknowledge
every message received or shut down the SubscriberClient.
- Pub/Sub Lite SubscriberClients do not wait for all messages to be
acknowledged before Receive() returns.
- Pub/Sub Lite has publish and subscribe throughput limits. Thus publishing
can be more sensitive to buffer overflow.
- Pub/Sub Lite PublisherClients can terminate when an unretryable error
occurs.
- DefaultPublishSettings and DefaultReceiveSettings should be used for default
settings rather than their empty types.
For more information about Cloud Pub/Sub Lite, see
https://cloud.google.com/pubsub/lite/docs.
Expand Down

0 comments on commit c4987c0

Please sign in to comment.