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

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

Classes
struct	PublishParams
	Wrap the arguments for `Publish()` More...

Public Member Functions
virtual	~BlockingPublisherConnection ()=0

virtual StatusOr< std::string >	Publish (PublishParams p)
	Defines the interface for `BlockingPublisher::Publish()` More...

virtual Options	options ()
	Returns the options configured at initialization time. More...

Detailed Description

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

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

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

The *Params nested classes: Applications may define classes derived from PublisherConnection, 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

◆ ~BlockingPublisherConnection()

virtual google::cloud::pubsub::BlockingPublisherConnection::~BlockingPublisherConnection ( )

pure virtual

Member Function Documentation

◆ options()

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

inlinevirtual

Returns the options configured at initialization time.

◆ Publish()

virtual StatusOr< std::string > google::cloud::pubsub::BlockingPublisherConnection::Publish ( PublishParams p )

virtual

Defines the interface for BlockingPublisher::Publish()