Classes | Enumerations | Functions
AS::Network Namespace Reference

Classes

class  TCPInterface
 
class  UDPInterface
 
class  UDPServer
 

Enumerations

enum  ByteOrder { ByteOrder::BE = 0, ByteOrder::LE }
 
enum  ReturnStatuses {
  ReturnStatuses::OK = 0, ReturnStatuses::INIT_FAILED = -1, ReturnStatuses::BAD_PARAM = -2, ReturnStatuses::SOCKET_ERROR = -3,
  ReturnStatuses::SOCKET_CLOSED = -4, ReturnStatuses::NO_MESSAGES_RECEIVED = -5, ReturnStatuses::READ_FAILED = -6, ReturnStatuses::WRITE_FAILED = -7,
  ReturnStatuses::CLOSE_FAILED = -8, ReturnStatuses::SOCKET_TIMEOUT = -9
}
 

Functions

template<typename C >
int32_t find_magic_word (const C &in, const size_t &magic_word)
 
template<class T , class C >
void parse_tuple (const C &in, T *out1, T *out2, ByteOrder bo, const uint16_t &offset)
 
template<class T , class C >
read_be (const C &bufArray, const uint32_t &offset)
 
template<class T , class C >
read_be (const C &bufArray, const uint32_t &offset, const float &factor, const float &valueOffset)
 
template<class T , class C >
read_le (const C &bufArray, const uint32_t &offset)
 
template<class T , class C >
read_le (const C &bufArray, const uint32_t &offset, const float &factor, const float &valueOffset)
 
std::string return_status_desc (const ReturnStatuses &ret)
 
template<class T >
std::vector< uint8_t > write_be (T *source, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
 
template<class T >
std::vector< uint8_t > write_be (T *source, typename std::enable_if< std::is_integral< T >::value >::type *=0)
 
template<class T >
std::vector< uint8_t > write_le (T *source, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
 
template<class T >
std::vector< uint8_t > write_le (T *source, typename std::enable_if< std::is_integral< T >::value >::type *=0)
 

Enumeration Type Documentation

◆ ByteOrder

Enumerator
BE 
LE 

Definition at line 30 of file common.h.

◆ ReturnStatuses

Enumerator
OK 
INIT_FAILED 
BAD_PARAM 
SOCKET_ERROR 
SOCKET_CLOSED 
NO_MESSAGES_RECEIVED 
READ_FAILED 
WRITE_FAILED 
CLOSE_FAILED 
SOCKET_TIMEOUT 

Definition at line 16 of file common.h.

Function Documentation

◆ find_magic_word()

template<typename C >
int32_t AS::Network::find_magic_word ( const C &  in,
const size_t &  magic_word 
)
inline

Definition at line 203 of file network_utils.h.

◆ parse_tuple()

template<class T , class C >
void AS::Network::parse_tuple ( const C &  in,
T *  out1,
T *  out2,
ByteOrder  bo,
const uint16_t &  offset 
)

Definition at line 230 of file network_utils.h.

◆ read_be() [1/2]

template<class T , class C >
T AS::Network::read_be ( const C &  bufArray,
const uint32_t &  offset 
)

Definition at line 141 of file network_utils.h.

◆ read_be() [2/2]

template<class T , class C >
T AS::Network::read_be ( const C &  bufArray,
const uint32_t &  offset,
const float &  factor,
const float &  valueOffset 
)

Definition at line 115 of file network_utils.h.

◆ read_le() [1/2]

template<class T , class C >
T AS::Network::read_le ( const C &  bufArray,
const uint32_t &  offset 
)

Definition at line 54 of file network_utils.h.

◆ read_le() [2/2]

template<class T , class C >
T AS::Network::read_le ( const C &  bufArray,
const uint32_t &  offset,
const float &  factor,
const float &  valueOffset 
)

Definition at line 28 of file network_utils.h.

◆ return_status_desc()

std::string AS::Network::return_status_desc ( const ReturnStatuses ret)

Definition at line 11 of file utils.cpp.

◆ write_be() [1/2]

template<class T >
std::vector<uint8_t> AS::Network::write_be ( T *  source,
typename std::enable_if< std::is_floating_point< T >::value >::type *  = 0 
)

Definition at line 174 of file network_utils.h.

◆ write_be() [2/2]

template<class T >
std::vector<uint8_t> AS::Network::write_be ( T *  source,
typename std::enable_if< std::is_integral< T >::value >::type *  = 0 
)

Definition at line 150 of file network_utils.h.

◆ write_le() [1/2]

template<class T >
std::vector<uint8_t> AS::Network::write_le ( T *  source,
typename std::enable_if< std::is_floating_point< T >::value >::type *  = 0 
)

Definition at line 85 of file network_utils.h.

◆ write_le() [2/2]

template<class T >
std::vector<uint8_t> AS::Network::write_le ( T *  source,
typename std::enable_if< std::is_integral< T >::value >::type *  = 0 
)

Definition at line 63 of file network_utils.h.



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