Protocol++® (Protocolpp®)  v5.6.2
ProtocolPP::judp Class Reference
Inheritance diagram for ProtocolPP::judp:
Collaboration diagram for ProtocolPP::judp:

Public Member Functions

 judp (std::shared_ptr< judpsa > &security)
 
 judp (std::shared_ptr< judpsa > &security, std::string &file)
 
virtual ~judp ()=default
 Standard deconstructor.
 
void encap_packet (std::shared_ptr< jarray< uint8_t >> &output)
 
void encap_packet (std::shared_ptr< jarray< uint8_t >> &input, std::shared_ptr< jarray< uint8_t >> &output)
 
void decap_packet (std::shared_ptr< jarray< uint8_t >> &input)
 
void decap_packet (std::shared_ptr< jarray< uint8_t >> &input, std::shared_ptr< jarray< uint8_t >> &output)
 
void set_field (field_t field, uint64_t value)
 
void set_hdr (jarray< uint8_t > &hdr)
 
uint64_t get_field (field_t field)
 
uint64_t get_field (field_t field, jarray< uint8_t > &hdr)
 
jarray< uint8_t > get_hdr ()
 
void get_security (std::shared_ptr< judpsa > &sec)
 
void to_xml (tinyxml2::XMLPrinter &myxml, direction_t direction)
 
void to_json (std::ofstream &myjson, direction_t direction, std::string &indent)
 
 judp (judp &judp)=delete
 
 judp (const judp &judp)=delete
 
- Public Member Functions inherited from ProtocolPP::jprotocol
 jprotocol (direction_t dir)
 
 jprotocol (direction_t dir, std::string &file)
 
 jprotocol (direction_t dir, std::shared_ptr< jrand > &rand)
 
 jprotocol (direction_t dir, std::shared_ptr< jrand > &rand, std::string &file)
 
virtual ~jprotocol ()
 Standard deconstructor.
 
bool hasfile ()
 
uint32_t get_status ()
 
jarray< uint8_t > checksum (iana_t prot, direction_t dir, jarray< uint8_t > &check, uint32_t offset=0)
 
jarray< uint8_t > pad (pad_t padtype, uint32_t len)
 
 jprotocol (jprotocol &jprotocol)=delete
 
 jprotocol (const jprotocol &jprotocol)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from ProtocolPP::jprotocol
const static std::string currentDateTime ()
 
static std::string str_status (uint32_t status)
 
static jarray< uint8_t > to_array (uint8_t input)
 
static jarray< uint8_t > to_array (uint16_t input)
 
static jarray< uint8_t > to_array (uint32_t input)
 
static jarray< uint8_t > to_array (uint64_t input)
 
static uint8_t to_u8 (jarray< uint8_t > src_array)
 
static uint16_t to_u16 (jarray< uint8_t > src_array)
 
static uint32_t to_u32 (jarray< uint8_t > src_array)
 
static uint64_t to_u64 (jarray< uint8_t > src_array)
 
static uint32_t fnv_hash (std::shared_ptr< jarray< uint8_t >> &header, jarray< uint8_t > &mask, uint32_t hdrlen)
 
- Protected Member Functions inherited from ProtocolPP::jprotocol
template<typename T , typename TE >
std::shared_ptr< jreplay< T, TE > > update_replay (protocol_t prot, T &seqnum, TE &extseq, bool usext, uint32_t size)
 
template<typename T , typename TE >
std::shared_ptr< jreplay< T, TE > > update_replay (protocol_t prot, T &seqnum, TE &extseq, bool usext, uint32_t size, jarray< uint8_t > &window)
 
void update_status (uint32_t stat)
 
void get_data (std::shared_ptr< jarray< uint8_t >> &data)
 
void put_data (std::shared_ptr< jarray< uint8_t >> &wdata)
 
void encryptdat (std::shared_ptr< jarray< uint8_t >> &red, std::shared_ptr< jarray< uint8_t >> &black)
 
void decryptdat (std::shared_ptr< jarray< uint8_t >> &black, std::shared_ptr< jarray< uint8_t >> &red)
 
uint32_t roundup (uint32_t value, uint32_t mult)
 
- Protected Attributes inherited from ProtocolPP::jprotocol
direction_t m_dir
 direction of processing
 
uint32_t m_status
 
std::shared_ptr< jrandm_rand
 random data generator passed into constructor
 
std::string m_filename
 file input string for this protocol
 
std::fstream m_file
 input file stream object for this protocol
 
endian_t m_endian
 endianess string for this protocol
 

Constructor & Destructor Documentation

◆ judp() [1/2]

ProtocolPP::judp::judp ( std::shared_ptr< judpsa > &  security)
explicit

constructor for normal UDP

Parameters
security- Parameters necessary to setup UDP flow

◆ judp() [2/2]

ProtocolPP::judp::judp ( std::shared_ptr< judpsa > &  security,
std::string &  file 
)

constructor for normal UDP with file input

Parameters
security- Parameters necessary to setup UDP flow
file- path to file to use for payload data

Member Function Documentation

◆ decap_packet() [1/2]

void ProtocolPP::judp::decap_packet ( std::shared_ptr< jarray< uint8_t >> &  input)
virtual

This function is for use with the constructor that accepts a file Decap will extract the data and write it to the file specificed in the constuctor

Parameters
input- UDP packet to decapsulate and write to file

Reimplemented from ProtocolPP::jprotocol.

◆ decap_packet() [2/2]

void ProtocolPP::judp::decap_packet ( std::shared_ptr< jarray< uint8_t >> &  input,
std::shared_ptr< jarray< uint8_t >> &  output 
)
virtual

This function is for use with the constructor without a file handle. Decap will produce a payload from the packet passed in

Parameters
input- UDP packet to decapsulate
output- decapsulated payload

Implements ProtocolPP::jprotocol.

◆ encap_packet() [1/2]

void ProtocolPP::judp::encap_packet ( std::shared_ptr< jarray< uint8_t >> &  input,
std::shared_ptr< jarray< uint8_t >> &  output 
)
virtual

This function is for use with the constructor without a file handle. Encap will produce a packet from the payload passed in

Parameters
input- payload to encapsulate with UDP
output- encapsulated UDP packet

Implements ProtocolPP::jprotocol.

◆ encap_packet() [2/2]

void ProtocolPP::judp::encap_packet ( std::shared_ptr< jarray< uint8_t >> &  output)
virtual

This function is for use with the constructor that accepts a file. Encap will produce a packet each time it's called from the data found in the file until all data is exhausted

Parameters
output- packet generated from payload data extracted from the file

Reimplemented from ProtocolPP::jprotocol.

◆ get_field() [1/2]

uint64_t ProtocolPP::judp::get_field ( field_t  field)
virtual

Retrieves the field from the security association

Returns
source address from the UDP header

Reimplemented from ProtocolPP::jprotocol.

◆ get_field() [2/2]

uint64_t ProtocolPP::judp::get_field ( field_t  field,
jarray< uint8_t > &  hdr 
)
virtual

Retrieves the field from the UDP header

Returns
source address from the UDP header

Implements ProtocolPP::jprotocol.

◆ get_hdr()

jarray<uint8_t> ProtocolPP::judp::get_hdr ( )
virtual

Retrieves the complete UDP header

Returns
the UDP header

Implements ProtocolPP::jprotocol.

◆ get_security()

void ProtocolPP::judp::get_security ( std::shared_ptr< judpsa > &  sec)

get_security

Parameters
sec- Shared pointer to hold the security association

◆ set_field()

void ProtocolPP::judp::set_field ( field_t  field,
uint64_t  value 
)
virtual

Allows the user to update the source address in the UDP header

Parameters
field- field to update in UDP
value- new value

Implements ProtocolPP::jprotocol.

◆ set_hdr()

void ProtocolPP::judp::set_hdr ( jarray< uint8_t > &  hdr)
virtual

Allows the user to update the complete UDP header

Parameters
hdr- new UDP header

Implements ProtocolPP::jprotocol.

◆ to_json()

void ProtocolPP::judp::to_json ( std::ofstream &  myjson,
direction_t  direction,
std::string &  indent 
)
virtual

Print the protocol object to JSON

Parameters
myjson- JSON object
direction- facilitator for random generation
indent- indentation for JSON output

Implements ProtocolPP::jprotocol.

◆ to_xml()

void ProtocolPP::judp::to_xml ( tinyxml2::XMLPrinter myxml,
direction_t  direction 
)
virtual

Print the protocol object to XML

Parameters
myxml- XMLPrinter object
direction- facilitator for random generation

Implements ProtocolPP::jprotocol.


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