aare::ZmqSocketReceiver Class Reference

#include <ZmqSocketReceiver.hpp>

Inheritance diagram for aare::ZmqSocketReceiver:

Public Member Functions
	ZmqSocketReceiver (const std::string &endpoint)
	Construct a new ZmqSocketReceiver object.
void	connect ()
	Connect to the given endpoint subscribe to a Zmq published.
std::vector< ZmqFrame >	receive_n ()
void	disconnect ()
void	set_zmq_hwm (int hwm)
void	set_timeout_ms (int n)
void	set_potential_frame_size (size_t size)

Protected Attributes
void *	m_context {nullptr}
void *	m_socket {nullptr}
std::string	m_endpoint
int	m_zmq_hwm {1000}
int	m_timeout_ms {1000}
size_t	m_potential_frame_size {1024 * 1024}
char *	m_header_buffer = new char[m_max_header_size]

Static Protected Attributes
static constexpr size_t	m_max_header_size = 1024

Private Member Functions
int	receive_data (std::byte *data, size_t size)
	receive data following a ZmqHeader
ZmqFrame	receive_zmqframe ()
ZmqHeader	receive_header ()
	receive a ZmqHeader

Constructor & Destructor Documentation

ZmqSocketReceiver()

aare::ZmqSocketReceiver::ZmqSocketReceiver

(

const std::string &

endpoint

)

Construct a new ZmqSocketReceiver object.

Member Function Documentation

connect()

void aare::ZmqSocketReceiver::connect

(

)

Connect to the given endpoint subscribe to a Zmq published.

disconnect()

void aare::ZmqSocket::disconnect ( )

inherited

receive_data()

int aare::ZmqSocketReceiver::receive_data ( std::byte *  data, size_t  size  )

private

receive data following a ZmqHeader

Parameters

data	pointer to data
size	size of data

Returns

ZmqHeader

receive_header()

ZmqHeader aare::ZmqSocketReceiver::receive_header ( )

private

receive a ZmqHeader

Returns

ZmqHeader

receive_n()

std::vector< ZmqFrame > aare::ZmqSocketReceiver::receive_n

(

)

receive_zmqframe()

ZmqFrame aare::ZmqSocketReceiver::receive_zmqframe ( )

private

set_potential_frame_size()

void aare::ZmqSocket::set_potential_frame_size ( size_t  size )

inherited

set_timeout_ms()

void aare::ZmqSocket::set_timeout_ms ( int  n )

inherited

set_zmq_hwm()

void aare::ZmqSocket::set_zmq_hwm ( int  hwm )

inherited

Field Documentation

m_context

void* aare::ZmqSocket::m_context {nullptr}

protectedinherited

m_endpoint

std::string aare::ZmqSocket::m_endpoint

protectedinherited

m_header_buffer

char* aare::ZmqSocket::m_header_buffer = new char[m_max_header_size]

protectedinherited

m_max_header_size

constexpr size_t aare::ZmqSocket::m_max_header_size = 1024

staticconstexprprotectedinherited

m_potential_frame_size

size_t aare::ZmqSocket::m_potential_frame_size {1024 * 1024}

protectedinherited

m_socket

void* aare::ZmqSocket::m_socket {nullptr}

protectedinherited

m_timeout_ms

int aare::ZmqSocket::m_timeout_ms {1000}

protectedinherited

m_zmq_hwm

int aare::ZmqSocket::m_zmq_hwm {1000}

protectedinherited

---

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

• network_io/include/aare/network_io/ZmqSocketReceiver.hpp
• network_io/src/ZmqSocketReceiver.cpp