Public Member Functions | Protected Attributes | List of all members
sick_scansegment_xd::UdpReceiverSocketImpl Class Reference

#include <udp_sockets.h>

Public Member Functions

bool Init (const std::string &udp_sender, int udp_port, bool blocking=false)
 
int port (void) const
 
size_t Receive (std::vector< uint8_t > &msg_payload)
 
size_t Receive (std::vector< uint8_t > &msg_payload, double timeout, const std::vector< uint8_t > &udp_msg_start_seq)
 
bool & running (void)
 
 UdpReceiverSocketImpl ()
 
 ~UdpReceiverSocketImpl ()
 

Protected Attributes

bool m_recv_blocking
 
int m_recv_flags
 
bool m_running
 
int m_udp_port
 
std::string m_udp_sender
 
SOCKET m_udp_socket
 

Detailed Description

Definition at line 106 of file udp_sockets.h.

Constructor & Destructor Documentation

◆ UdpReceiverSocketImpl()

sick_scansegment_xd::UdpReceiverSocketImpl::UdpReceiverSocketImpl ( )
inline

Default constructor

Definition at line 111 of file udp_sockets.h.

◆ ~UdpReceiverSocketImpl()

sick_scansegment_xd::UdpReceiverSocketImpl::~UdpReceiverSocketImpl ( )
inline

Destructor, closes the socket

Definition at line 116 of file udp_sockets.h.

Member Function Documentation

◆ Init()

bool sick_scansegment_xd::UdpReceiverSocketImpl::Init ( const std::string &  udp_sender,
int  udp_port,
bool  blocking = false 
)
inline

Definition at line 139 of file udp_sockets.h.

◆ port()

int sick_scansegment_xd::UdpReceiverSocketImpl::port ( void  ) const
inline

Return the udp port

Definition at line 254 of file udp_sockets.h.

◆ Receive() [1/2]

size_t sick_scansegment_xd::UdpReceiverSocketImpl::Receive ( std::vector< uint8_t > &  msg_payload)
inline

Reads blocking until some data has been received successfully or an error occurs. Returns the number of bytes received.

Definition at line 197 of file udp_sockets.h.

◆ Receive() [2/2]

size_t sick_scansegment_xd::UdpReceiverSocketImpl::Receive ( std::vector< uint8_t > &  msg_payload,
double  timeout,
const std::vector< uint8_t > &  udp_msg_start_seq 
)
inline

Reads blocking until all bytes of a msgpack incl. header and crc have been received or an error occurs. Returns the number of bytes received.

Definition at line 212 of file udp_sockets.h.

◆ running()

bool& sick_scansegment_xd::UdpReceiverSocketImpl::running ( void  )
inline

Return true, if socket is ready to receive, or false otherwise. Set false to signal stop receiving

Definition at line 257 of file udp_sockets.h.

Member Data Documentation

◆ m_recv_blocking

bool sick_scansegment_xd::UdpReceiverSocketImpl::m_recv_blocking
protected

Definition at line 265 of file udp_sockets.h.

◆ m_recv_flags

int sick_scansegment_xd::UdpReceiverSocketImpl::m_recv_flags
protected

Definition at line 266 of file udp_sockets.h.

◆ m_running

bool sick_scansegment_xd::UdpReceiverSocketImpl::m_running
protected

Definition at line 264 of file udp_sockets.h.

◆ m_udp_port

int sick_scansegment_xd::UdpReceiverSocketImpl::m_udp_port
protected

Definition at line 262 of file udp_sockets.h.

◆ m_udp_sender

std::string sick_scansegment_xd::UdpReceiverSocketImpl::m_udp_sender
protected

Definition at line 261 of file udp_sockets.h.

◆ m_udp_socket

SOCKET sick_scansegment_xd::UdpReceiverSocketImpl::m_udp_socket
protected

Definition at line 263 of file udp_sockets.h.


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


sick_scan_xd
Author(s): Michael Lehning , Jochen Sprickerhof , Martin Günther
autogenerated on Fri Oct 25 2024 02:47:21