ProtocolPP::jstream Class Reference

Public Member Functions
	jstream ()
	Constructor for jstream.
	jstream (std::string name, direction_t dir, protocol_t type, bool postprocess, std::shared_ptr< jsecass > security, std::shared_ptr< jprotocol > engine)
	jstream (std::string name, direction_t dir, protocol_t type, bool postprocess, std::shared_ptr< jsecass > security)
	jstream (std::string name, direction_t dir, protocol_t type, bool postprocess, std::shared_ptr< jprotocol > engine)
	jstream (jstream &rhs)
	jstream (const jstream &rhs)
virtual	~jstream ()=default
	Standard deconstructor.
template<typename T >
void	set_field (field_t field, T value)
	set the field
template<typename T >
T	get_field (field_t field)
	get the field
template<typename T >
void	set_security (std::shared_ptr< T > &security)
void	set_engine (std::shared_ptr< jprotocol > engine)
template<typename T >
void	get_security (std::shared_ptr< T > &security)
void	get_engine (std::shared_ptr< jprotocol > &newengine)
	Get the encryption engine for this stream.
void	clean ()

Constructor & Destructor Documentation

jstream() [1/5]

ProtocolPP::jstream::jstream	(	std::string	name,
		direction_t	dir,
		protocol_t	type,
		bool	postprocess,
		std::shared_ptr< jsecass >	security,
		std::shared_ptr< jprotocol >	engine
	)

Constructor for jstream

Parameters

name	- name of the stream
dir	- direction of processing
type	- type of security association
postprocess	- if using a random IV, postprocess the descriptor to decap the payload and verify
security	- Security association for this stream
engine	- Encryption engine for this stream

jstream() [2/5]

ProtocolPP::jstream::jstream	(	std::string	name,
		direction_t	dir,
		protocol_t	type,
		bool	postprocess,
		std::shared_ptr< jsecass >	security
	)

Constructor for jstream

Parameters

name	- name of the stream
dir	- direction of processing
type	- type of security association
postprocess	- if using a random IV, postprocess the descriptor to decap the payload and verify
security	- Security association for this stream

jstream() [3/5]

ProtocolPP::jstream::jstream	(	std::string	name,
		direction_t	dir,
		protocol_t	type,
		bool	postprocess,
		std::shared_ptr< jprotocol >	engine
	)

Constructor for jstream

Parameters

name	- name of the stream
dir	- direction of processing
type	- type of security association
postprocess	- if using a random IV, postprocess the descriptor to decap the payload and verify
engine	- Encryption engine for this stream

jstream() [4/5]

ProtocolPP::jstream::jstream

(

jstream &

rhs

)

Constructor for jstream

Parameters

rhs	- jstream to copy

jstream() [5/5]

ProtocolPP::jstream::jstream

(

const jstream &

rhs

)

Constructor for jstream

Parameters

rhs	- jstream to copy

Member Function Documentation

clean()

void ProtocolPP::jstream::clean

(

)

Erase the encryption engine if not needed Encryption engine is only needed to generate random packets. If running W.A.S.P, the encryption engine will be deleted after generating random packets to reduce the memory footprint of the stream object

get_security()

template<typename T >

void ProtocolPP::jstream::get_security

(

std::shared_ptr< T > &

security

)

Get the security association for this stream NOTE : User must cast the security association to its correct type

set_engine()

void ProtocolPP::jstream::set_engine

(

std::shared_ptr< jprotocol >

engine

)

Set the encryption engine for this stream

Parameters

engine

- encryption engine

set_security()

template<typename T >

void ProtocolPP::jstream::set_security

(

std::shared_ptr< T > &

security

)

Set the security association for this stream

Parameters

security

- pointer to security association

---

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

• include/jstream.h