google::cloud::pubsub::SubscriberConnection Class Reference

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

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

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

Public Member Functions
virtual	~SubscriberConnection ()=0
virtual future< Status >	Subscribe (SubscribeParams p)
	Defines the interface for Subscriber::Subscribe(ApplicationCallback) More...
virtual future< Status >	ExactlyOnceSubscribe (ExactlyOnceSubscribeParams p)
	Defines the interface for Subscriber::Subscribe(ExactlyOnceApplicationCallback). More...
virtual StatusOr< PullResponse >	Pull ()
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.

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 )

virtual

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 ( )

inlinevirtual

Returns the configuration parameters for this object.

Pull()

virtual StatusOr< PullResponse > google::cloud::pubsub::SubscriberConnection::Pull ( )

virtual

Subscribe()

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

virtual

Defines the interface for Subscriber::Subscribe(ApplicationCallback)