libpqxx  4.0.1
pqxx::notification_receiver Class Referenceabstract

#include <notification.hxx>

Inheritance diagram for pqxx::notification_receiver:
pqxx::internal::notify_listener_forwarder

Public Member Functions

 notification_receiver (connection_base &c, const std::string &channel)
 Register the receiver with a connection. More...
 
virtual ~notification_receiver ()
 
const std::string & channel () const
 The channel that this receiver listens on. More...
 
virtual void operator() (const std::string &payload, int backend_pid)=0
 Overridable: action to invoke when notification arrives. More...
 

Protected Member Functions

connection_baseconn () const throw ()
 

Constructor & Destructor Documentation

◆ notification_receiver()

pqxx::notification_receiver::notification_receiver ( connection_base c,
const std::string &  channel 
)

Register the receiver with a connection.

Parameters
cConnnection to operate on.
channelName of the notification to listen for.

◆ ~notification_receiver()

pqxx::notification_receiver::~notification_receiver ( )
virtual

References conn().

Member Function Documentation

◆ channel()

const std::string& pqxx::notification_receiver::channel ( ) const

The channel that this receiver listens on.

Referenced by pqxx::connection_base::trace().

◆ conn()

connection_base& pqxx::notification_receiver::conn ( ) const
throw (
)
protected

◆ operator()()

virtual void pqxx::notification_receiver::operator() ( const std::string &  payload,
int  backend_pid 
)
pure virtual

Overridable: action to invoke when notification arrives.

Parameters
payloadOn PostgreSQL 9.0 or later, an optional string that may have been passed to the NOTIFY command.
backend_pidProcess ID of the database backend process that served our connection when the notification arrived. The actual process ID behind the connection may have changed by the time this method is called.

Implemented in pqxx::internal::notify_listener_forwarder.


The documentation for this class was generated from the following files: