Google Cloud Pub/Sub C++ Client  1.42.0
A C++ Client Library for Google Cloud Pub/Sub
Classes | Namespaces | Typedefs | Enumerations | Functions
options.h File Reference

This file defines options to be used with instances of google::cloud::Options. More...

#include "google/cloud/pubsub/backoff_policy.h"
#include "google/cloud/pubsub/retry_policy.h"
#include "google/cloud/pubsub/version.h"
#include "google/cloud/options.h"
#include <chrono>

Go to the source code of this file.

Classes

struct  google::cloud::pubsub::RetryPolicyOption
 The retry policy. More...
 
struct  google::cloud::pubsub::BackoffPolicyOption
 The backoff policy. More...
 
struct  google::cloud::pubsub::MaxHoldTimeOption
 The maximum hold time for the messages. More...
 
struct  google::cloud::pubsub::MaxBatchMessagesOption
 The maximum number of messages in a batch. More...
 
struct  google::cloud::pubsub::MaxBatchBytesOption
 The maximum size for the messages in a batch. More...
 
struct  google::cloud::pubsub::MaxPendingMessagesOption
 The maximum number of pending messages. More...
 
struct  google::cloud::pubsub::MaxPendingBytesOption
 The maximum size for pending messages. More...
 
struct  google::cloud::pubsub::MessageOrderingOption
 Publisher message ordering. More...
 
struct  google::cloud::pubsub::FullPublisherActionOption
 The action taken by a full publisher. More...
 
struct  google::cloud::pubsub::CompressionThresholdOption
 Compression threshold. More...
 
struct  google::cloud::pubsub::CompressionAlgorithmOption
 Compression algorithm. More...
 
struct  google::cloud::pubsub::MaxDeadlineTimeOption
 The maximum deadline for each incoming message. More...
 
struct  google::cloud::pubsub::MaxDeadlineExtensionOption
 The maximum time by which the deadline for each incoming message is extended. More...
 
struct  google::cloud::pubsub::MaxOutstandingMessagesOption
 The maximum number of outstanding messages per streaming pull. More...
 
struct  google::cloud::pubsub::MaxOutstandingBytesOption
 The maximum number of outstanding bytes per streaming pull. More...
 
struct  google::cloud::pubsub::MaxConcurrencyOption
 The maximum callback concurrency. More...
 
struct  google::cloud::pubsub::ShutdownPollingPeriodOption
 How often the session polls for automatic shutdowns. More...
 

Namespaces

 google
 
 google::cloud
 The namespace Google Cloud Platform C++ client libraries.
 
 google::cloud::pubsub
 Contains all the Cloud Pub/Sub C++ client types and functions.
 

Typedefs

using google::cloud::pubsub::PolicyOptionList = OptionList< RetryPolicyOption, BackoffPolicyOption >
 The list of all "policy" options. More...
 
using google::cloud::pubsub::PublisherOptionList = OptionList< MaxHoldTimeOption, MaxBatchMessagesOption, MaxBatchBytesOption, MaxPendingMessagesOption, MaxPendingBytesOption, MessageOrderingOption, FullPublisherActionOption, CompressionThresholdOption >
 The list of options specific to publishers. More...
 
using google::cloud::pubsub::SubscriberOptionList = OptionList< MaxDeadlineTimeOption, MaxDeadlineExtensionOption, MaxOutstandingMessagesOption, MaxOutstandingBytesOption, MaxConcurrencyOption, ShutdownPollingPeriodOption >
 The list of options specific to subscribers. More...
 

Enumerations

enum class  google::cloud::pubsub::FullPublisherAction { google::cloud::pubsub::kIgnored , google::cloud::pubsub::kRejects , google::cloud::pubsub::kBlocks }
 Actions taken by a full publisher. More...
 

Functions

Options google::cloud::pubsub::IAMPolicyOptions (Options opts={})
 Convenience function to initialize a google::cloud::iam::IAMPolicyConnection. More...
 

Detailed Description

This file defines options to be used with instances of google::cloud::Options.

By convention options are named with an "Option" suffix. As the name would imply, all options are optional, and leaving them unset will result in a reasonable default being chosen.

Not all options are meaningful to all functions that accept a google::cloud::Options instance. Each function that accepts a google::cloud::Options should document which options it expects. This is typically done by indicating lists of options using "OptionList" aliases. For example, a function may indicate that users may set any option in PublisherOptionList.

Note
Unrecognized options are allowed and will be ignored. To debug issues with options set GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes in the environment and unexpected options will be logged.
See also
google::cloud::CommonOptionList
google::cloud::GrpcOptionList

Definition in file options.h.