synapse-app-sdk
C++ SDK for Synapse Apps
Loading...
Searching...
No Matches
synapse::ZMQDataReader Class Reference

Class for reading data from ZeroMQ publishers. More...

#include <data_reader.hpp>

Public Member Functions

 ZMQDataReader (zmq::context_t &context)
 Constructor for ZMQDataReader.
 ~ZMQDataReader ()
 Destructor - ensures socket is closed and resources are cleaned up.
bool connect (const std::string &publisher_endpoint)
 Connects to a ZMQ publisher endpoint.
std::optional< zmq::message_t > receive_message ()
 Receives a single message from the connected publisher.
std::vector< zmq::message_t > receive_multipart ()
 Receives a multipart message from the connected publisher.

Detailed Description

Class for reading data from ZeroMQ publishers.

Provides functionality to connect to a ZMQ publisher endpoint and receive messages.

Constructor & Destructor Documentation

◆ ZMQDataReader()

synapse::ZMQDataReader::ZMQDataReader ( zmq::context_t & context)
explicit

Constructor for ZMQDataReader.

Parameters
contextZMQ context to use for socket creation

Member Function Documentation

◆ connect()

bool synapse::ZMQDataReader::connect ( const std::string & publisher_endpoint)

Connects to a ZMQ publisher endpoint.

Parameters
publisher_endpointEndpoint string to connect to
Returns
true if connection was successful, false otherwise

◆ receive_message()

std::optional< zmq::message_t > synapse::ZMQDataReader::receive_message ( )

Receives a single message from the connected publisher.

Returns
std::optional<zmq::message_t> Message if available, std::nullopt if no message

◆ receive_multipart()

std::vector< zmq::message_t > synapse::ZMQDataReader::receive_multipart ( )

Receives a multipart message from the connected publisher.

Returns
std::vector<zmq::message_t> Vector of message parts, empty if no message available

The documentation for this class was generated from the following files:
  • include/synapse-app-sdk/middleware/data_reader.hpp
  • src/middleware/data_reader.cpp