notification.hxx

Go to the documentation of this file.

/* Definition of the pqxx::notification_receiver functor interface.
 *
 * pqxx::notification_receiver handles incoming notifications.
 *
 * DO NOT INCLUDE THIS FILE DIRECTLY; include pqxx/notification instead.
 *
 * Copyright (c) 2000-2025, 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.
 */
#ifndef PQXX_H_NOTIFICATION
#define PQXX_H_NOTIFICATION
 
#if !defined(PQXX_HEADER_PRE)
#  error "Include libpqxx headers as <pqxx/header>, not <pqxx/header.hxx>."
#endif
 
#include <string>
 
#include "pqxx/types.hxx"
 
 
namespace pqxx
{

class PQXX_LIBEXPORT PQXX_NOVTABLE notification_receiver
{
public:

  [[deprecated("Use pqxx::connection::listen() instead.")]]
  notification_receiver(connection &cx, std::string_view channel);
  [[deprecated("Use pqxx::connection::listen() instead.")]]
  notification_receiver(notification_receiver const &) = delete;
  [[deprecated("Use pqxx::connection::listen() instead.")]]
  notification_receiver &operator=(notification_receiver const &) = delete;
  virtual ~notification_receiver();

  [[nodiscard]] std::string const &channel() const & { return m_channel; }


  virtual void operator()(std::string const &payload, int backend_pid) = 0;
 
protected:
  connection &conn() const noexcept { return m_conn; }
 
private:
  connection &m_conn;
  std::string m_channel;
};
} // namespace pqxx
#endif