Google Cloud Pub/Sub C++ Client  2.4.0
A C++ Client Library for Google Cloud Pub/Sub
Classes | Public Member Functions | List of all members
google::cloud::pubsub::SubscriberConnection Class Referenceabstract

A connection to the Cloud Pub/Sub service to receive events. More...

#include <google/cloud/pubsub/subscriber_connection.h>


struct  ExactlyOnceSubscribeParams
struct  SubscribeParams
 Wrap the arguments for Subscribe() More...

Public Member Functions

virtual ~SubscriberConnection ()=0
virtual future< StatusSubscribe (SubscribeParams p)
 Defines the interface for Subscriber::Subscribe(ApplicationCallback) More...
virtual future< StatusExactlyOnceSubscribe (ExactlyOnceSubscribeParams p)
 Defines the interface for Subscriber::Subscribe(ExactlyOnceApplicationCallback). More...
virtual Options options ()
 Returns the configuration parameters for this object. More...

Detailed Description

A connection to the Cloud Pub/Sub service to receive events.

This interface defines pure-virtual functions for each of the user-facing overload sets in Subscriber. That is, all of Subscriber's overloads will forward to the one pure-virtual function declared in this interface. This allows users to inject custom behavior (e.g., with a Google Mock object) in a Subscriber object for use in their own tests.

To create a concrete instance that connects you to the real Cloud Pub/Sub service, see MakeSubscriberConnection().

The *Params nested classes
Applications may define classes derived from SubscriberConnection, for example, because they want to mock the class. To avoid breaking all such derived classes when we change the number or type of the arguments to the member functions we define lightweight structures to pass the arguments.

Definition at line 57 of file subscriber_connection.h.

Constructor & Destructor Documentation

◆ ~SubscriberConnection()

virtual google::cloud::pubsub::SubscriberConnection::~SubscriberConnection ( )
pure virtual

Member Function Documentation

◆ ExactlyOnceSubscribe()

virtual future<Status> google::cloud::pubsub::SubscriberConnection::ExactlyOnceSubscribe ( ExactlyOnceSubscribeParams  p)

Defines the interface for Subscriber::Subscribe(ExactlyOnceApplicationCallback).

We use a different name for this function (as opposed to an overload) to simplify the use of mocks.

◆ options()

virtual Options google::cloud::pubsub::SubscriberConnection::options ( )

Returns the configuration parameters for this object.

Definition at line 83 of file subscriber_connection.h.

◆ Subscribe()

virtual future<Status> google::cloud::pubsub::SubscriberConnection::Subscribe ( SubscribeParams  p)

Defines the interface for Subscriber::Subscribe(ApplicationCallback)