Public Member Functions | Private Attributes | List of all members
AS::Network::UDPInterface Class Reference

#include <network_interface.h>

Public Member Functions

ReturnStatuses close ()
 
bool is_open ()
 
ReturnStatuses open (const std::string &ip_address, uint32_t port)
 
ReturnStatuses open (const std::string &ip_address, uint32_t port, uint32_t receive_buffer_size)
 
ReturnStatuses read (std::vector< uint8_t > *msg)
 
 UDPInterface ()
 
ReturnStatuses write (const std::vector< uint8_t > &msg)
 

Private Attributes

boost::asio::io_service io_service_
 
uint32_t receive_buffer_size_ = 1024
 
boost::asio::ip::udp::endpoint sender_endpoint_
 
boost::asio::ip::udp::socket socket_
 

Detailed Description

Definition at line 32 of file network_interface.h.

Constructor & Destructor Documentation

◆ UDPInterface()

UDPInterface::UDPInterface ( )

Definition at line 17 of file udp_interface.cpp.

Member Function Documentation

◆ close()

ReturnStatuses UDPInterface::close ( )

Definition at line 57 of file udp_interface.cpp.

◆ is_open()

bool UDPInterface::is_open ( )

Definition at line 71 of file udp_interface.cpp.

◆ open() [1/2]

ReturnStatuses UDPInterface::open ( const std::string &  ip_address,
uint32_t  port 
)

Definition at line 28 of file udp_interface.cpp.

◆ open() [2/2]

ReturnStatuses UDPInterface::open ( const std::string &  ip_address,
uint32_t  port,
uint32_t  receive_buffer_size 
)

Definition at line 22 of file udp_interface.cpp.

◆ read()

ReturnStatuses UDPInterface::read ( std::vector< uint8_t > *  msg)

Definition at line 76 of file udp_interface.cpp.

◆ write()

ReturnStatuses UDPInterface::write ( const std::vector< uint8_t > &  msg)

Definition at line 92 of file udp_interface.cpp.

Member Data Documentation

◆ io_service_

boost::asio::io_service AS::Network::UDPInterface::io_service_
private

Definition at line 55 of file network_interface.h.

◆ receive_buffer_size_

uint32_t AS::Network::UDPInterface::receive_buffer_size_ = 1024
private

Definition at line 54 of file network_interface.h.

◆ sender_endpoint_

boost::asio::ip::udp::endpoint AS::Network::UDPInterface::sender_endpoint_
private

Definition at line 57 of file network_interface.h.

◆ socket_

boost::asio::ip::udp::socket AS::Network::UDPInterface::socket_
private

Definition at line 56 of file network_interface.h.


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


network_interface
Author(s): Joshua Whitley , Daniel Stanek , Joe Kale
autogenerated on Wed Mar 2 2022 00:35:33