aare::ZmqSocketSender Class Reference

#include <ZmqSocketSender.hpp>

Inheritance diagram for aare::ZmqSocketSender:

Public Member Functions
	ZmqSocketSender (const std::string &endpoint)
void	bind ()
size_t	send (const ZmqHeader &header, const std::byte *data, size_t size)
size_t	send (const ZmqFrame &zmq_frame)
size_t	send (const std::vector< ZmqFrame > &zmq_frames)
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

Constructor & Destructor Documentation

ZmqSocketSender()

aare::ZmqSocketSender::ZmqSocketSender

(

const std::string &

endpoint

)

Constructor

Parameters

endpoint

ZMQ endpoint

Member Function Documentation

bind()

void aare::ZmqSocketSender::bind

(

)

bind to the given port

disconnect()

void aare::ZmqSocket::disconnect ( )

inherited

send() [1/3]

size_t aare::ZmqSocketSender::send

(

const std::vector< ZmqFrame > &

zmq_frames

)

Send a vector of headers and frames

Parameters

zmq_frames

vector of ZmqFrame

Returns

number of bytes sent

send() [2/3]

size_t aare::ZmqSocketSender::send

(

const ZmqFrame &

zmq_frame

)

Send a frame with a header

Parameters

ZmqFrame

that contains a header and a frame

Returns

number of bytes sent

send() [3/3]

size_t aare::ZmqSocketSender::send	(	const ZmqHeader &	header,
		const std::byte *	data,
		size_t	size
	)

send a header and data

Parameters

header
data	pointer to data
size	size of data

Returns

number of bytes sent

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/ZmqSocketSender.hpp
• network_io/src/ZmqSocketSender.cpp