yarilo::Recording Class Reference

Recordings utility class. More...

#include <recording.h>

Classes
struct	info
	Information about a saved recording. More...

Public Types
enum class	DataLinkType { RADIOTAP , RAW80211 , ETH2 }
	data link of a saved recording More...

Public Member Functions
	Recording (const std::filesystem::path &save_dir, bool dump_raw)
void	set_name (const std::string &basename)
std::optional< info >	dump (std::shared_ptr< PacketChannel > channel) const
std::optional< info >	dump (std::vector< Tins::Packet * > *packets) const

Static Public Member Functions
static std::unique_ptr< Tins::Packet >	make_eth_packet (Tins::Packet *pkt)

Detailed Description

Recordings utility class.

Member Enumeration Documentation

DataLinkType

enum yarilo::Recording::DataLinkType

strong

data link of a saved recording

Enumerator
RADIOTAP
RAW80211
ETH2

Constructor & Destructor Documentation

Recording()

yarilo::Recording::Recording	(	const std::filesystem::path &	save_dir,
		bool	dump_raw
	)

Constructs a new Recording object.

Parameters

[in]	save_dir	The directory where the recordings will be saved.
[in]	dump_raw	A boolean indicating whether to dump raw packet data.

Member Function Documentation

dump() [1/2]

std::optional< recording_info > yarilo::Recording::dump

(

std::shared_ptr< PacketChannel >

channel

)

const

Dumps the packets from the given PacketChannel to a recording file.

Parameters

[in]

channel

A shared pointer to the PacketChannel containing the packets to dump.

Returns

An optional containing some info about the recording.

dump() [2/2]

std::optional< recording_info > yarilo::Recording::dump

(

std::vector< Tins::Packet * > *

packets

)

const

Dumps the packets from the given packet vector to a recording file.

Parameters

[in]

channel

A shared pointer to the PacketChannel containing the packets to dump.

Returns

An optional containing some info about the recording.

make_eth_packet()

std::unique_ptr< Tins::Packet > yarilo::Recording::make_eth_packet ( Tins::Packet *  pkt )

static

Create an ethernet packet based on the decrypted 802.11 data packet

Parameters

[in]

pkt

The 802.11 Data packet to convert

Returns

The converted ethernet packet

set_name()

void yarilo::Recording::set_name ( const std::string &  basename )

inline

Sets the base name for the recording.

Parameters

[in]

basename

The base name to be used for the recording file (for example the AP name)

---

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

• /app/src/backend/src/recording.h
• /app/src/backend/src/recording.cpp