pqxx::notification_receiver Class Reference

#include <notification.hxx>

Public Member Functions
	notification_receiver (connection &cx, std::string_view channel, sl loc=sl::current())
	Register the receiver with a connection. More...
	notification_receiver (notification_receiver const &)=delete
	notification_receiver (notification_receiver &&)=delete
virtual	~notification_receiver ()
	Deregister the receiver. More...
notification_receiver &	operator= (notification_receiver const &)=delete
notification_receiver &	operator= (notification_receiver &&)=delete
std::string const &	channel () const &
	The channel that this receiver listens on. More...
virtual void	operator() (std::string const &payload, int backend_pid)=0
	Overridable: action to invoke when notification arrives. More...

Protected Member Functions
connection &	conn () const noexcept

Constructor & Destructor Documentation

notification_receiver() [1/3]

pqxx::notification_receiver::notification_receiver	(	connection &	cx,
		std::string_view	channel,
		sl	loc = sl::current()
	)

Register the receiver with a connection.

Parameters

cx	Connnection to operate on.
channel	Name of the notification to listen for.

Implementation of the pqxx::notification_receiever class.

pqxx::notification_receiver processes notifications.

Copyright (c) 2000-2026, Jeroen T. Vermeulen.

See COPYING for copyright license. If you did not receive a file called COPYING with this source code, please notify the distributor of this mistake, or contact the author.

notification_receiver() [2/3]

pqxx::notification_receiver::notification_receiver ( notification_receiver const &  )

delete

notification_receiver() [3/3]

pqxx::notification_receiver::notification_receiver ( notification_receiver &&  )

delete

~notification_receiver()

pqxx::notification_receiver::~notification_receiver ( )

virtual

Deregister the receiver.

Member Function Documentation

channel()

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

inline

The channel that this receiver listens on.

conn()

connection& pqxx::notification_receiver::conn ( ) const

inlineprotectednoexcept

operator()()

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

pure virtual

Overridable: action to invoke when notification arrives.

Parameters

payload	An optional string that may have been passed to the NOTIFY command.
backend_pid	Process 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.

operator=() [1/2]

notification_receiver& pqxx::notification_receiver::operator= ( notification_receiver &&  )

delete

operator=() [2/2]

notification_receiver& pqxx::notification_receiver::operator= ( notification_receiver const &  )

delete

---

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

• include/pqxx/notification.hxx
• src/notification.cxx