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

#include <network_interface.h>

Public Member Functions

ReturnStatuses close ()
 
bool is_open ()
 
ReturnStatuses open (std::string ip_address, const int &port)
 
ReturnStatuses read (std::vector< uint8_t > *msg)
 
ReturnStatuses read_exactly (std::vector< uint8_t > *msg, const size_t &bytes_to_read)
 
 TCPInterface ()
 
ReturnStatuses write (const std::vector< uint8_t > &msg)
 

Private Attributes

boost::system::error_code error_
 
boost::asio::io_service io_service_
 
boost::asio::ip::tcp::socket socket_
 

Detailed Description

Definition at line 60 of file network_interface.h.

Constructor & Destructor Documentation

◆ TCPInterface()

TCPInterface::TCPInterface ( )

Definition at line 17 of file tcp_interface.cpp.

Member Function Documentation

◆ close()

ReturnStatuses TCPInterface::close ( )

Definition at line 51 of file tcp_interface.cpp.

◆ is_open()

bool TCPInterface::is_open ( )

Definition at line 65 of file tcp_interface.cpp.

◆ open()

ReturnStatuses TCPInterface::open ( std::string  ip_address,
const int &  port 
)

Definition at line 22 of file tcp_interface.cpp.

◆ read()

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

Definition at line 70 of file tcp_interface.cpp.

◆ read_exactly()

ReturnStatuses TCPInterface::read_exactly ( std::vector< uint8_t > *  msg,
const size_t &  bytes_to_read 
)

Definition at line 89 of file tcp_interface.cpp.

◆ write()

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

Definition at line 108 of file tcp_interface.cpp.

Member Data Documentation

◆ error_

boost::system::error_code AS::Network::TCPInterface::error_
private

Definition at line 83 of file network_interface.h.

◆ io_service_

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

Definition at line 81 of file network_interface.h.

◆ socket_

boost::asio::ip::tcp::socket AS::Network::TCPInterface::socket_
private

Definition at line 82 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