Command Options. More...

#include <command_options.h>

Inheritance diagram for isc::perfdhcp::CommandOptions:

Classes
class	LeaseType
	A class encapsulating the type of lease being requested from the server. More...

Public Types
enum	ExchangeMode { DO_SA, DORA_SARR }
	2-way (cmd line param -i) or 4-way exchanges More...

typedef std::vector< std::vector< uint8_t > >	MacAddrsVector
	A vector holding MAC addresses. More...

Public Member Functions
int	getAggressivity () const
	Returns aggressivity value. More...

std::vector< std::string >	getBase () const
	Returns base values. More...

uint32_t	getClientsNum () const
	Returns number of simulated clients. More...

std::string	getDiags () const
	Returns diagnostic selectors. More...

std::vector< double >	getDropTime () const
	Returns drop time. More...

std::vector< uint8_t >	getDuidTemplate () const
	Returns DUID template. More...

int	getElapsedTimeOffset () const
	Returns template offset for elapsed time. More...

ExchangeMode	getExchangeMode () const
	Returns packet exchange mode. More...

int	getExitWaitTime () const
	Returns the time in microseconds to delay the program by. More...

const isc::dhcp::OptionCollection &	getExtraOpts () const
	Returns extra options to be inserted. More...

uint8_t	getIpVersion () const
	Returns IP version. More...

LeaseType	getLeaseType () const
	\ brief Returns the type of lease being requested. More...

std::string	getLocalName () const
	Returns local address or interface name. More...

int	getLocalPort () const
	Returns local port number. More...

std::string	getMacListFile () const
	Returns location of the file containing list of MAC addresses. More...

const MacAddrsVector &	getMacsFromFile () const
	Returns reference to a vector of MAC addresses read from a file. More...

std::vector< uint8_t >	getMacTemplate () const
	Returns MAC address template. More...

std::vector< int >	getMaxDrop () const
	Returns maximum drops number. More...

std::vector< double >	getMaxDropPercentage () const
	Returns maximal percentage of drops. More...

std::vector< int >	getNumRequests () const
	Returns maximum number of exchanges. More...

int	getPeriod () const
	Returns test period. More...

int	getPreload () const
	Returns number of preload exchanges. More...

std::vector< int >	getRandomOffset () const
	Returns template offsets for rnd. More...

int	getRate () const
	Returns exchange rate. More...

int	getReleaseRate () const
	Returns a rate at which DHCPv6 Release messages are sent. More...

int	getRenewRate () const
	Returns a rate at which DHCPv6 Renew messages are sent. More...

int	getReportDelay () const
	Returns delay between two performance reports. More...

int	getRequestedIpOffset () const
	Returns template offset for requested IP. More...

uint32_t	getSeed () const
	Returns random seed. More...

int	getServerIdOffset () const
	Returns template offset for server-ID. More...

std::string	getServerName () const
	Returns server name. More...

std::vector< std::string >	getTemplateFiles () const
	Returns template file names. More...

std::vector< int >	getTransactionIdOffset () const
	brief Returns template offsets for xid. More...

std::string	getWrapped () const
	Returns wrapped command. More...

bool	isBroadcast () const
	Checks if broadcast address is to be used. More...

bool	isInterface () const
	Checks if interface name was used. More...

bool	isRapidCommit () const
	Check if rapid commit option used. More...

bool	isSeeded () const
	Checks if seed provided. More...

bool	isUseFirst () const
	Check if server-ID to be taken from first package. More...

bool	isUseRelayedV6 () const
	Check if generated DHCPv6 messages should appear as relayed. More...

bool	parse (int argc, char **const argv, bool print_cmd_line=false)
	Parse command line. More...

void	printCommandLine () const
	Print command line arguments. More...

void	reset ()
	Reset to defaults. More...

void	usage () const
	Print usage. More...

void	version () const
	Print program version. More...

Static Public Member Functions
static CommandOptions &	instance ()
	CommandOptions is a singleton class. More...

Detailed Description

Command Options.

This class is responsible for parsing the command-line and storing the specified options.

Definition at line 25 of file command_options.h.

Member Typedef Documentation

◆ MacAddrsVector

typedef std::vector<std::vector<uint8_t> > isc::perfdhcp::CommandOptions::MacAddrsVector

A vector holding MAC addresses.

Definition at line 29 of file command_options.h.

Member Enumeration Documentation

◆ ExchangeMode

enum isc::perfdhcp::CommandOptions::ExchangeMode

2-way (cmd line param -i) or 4-way exchanges

Enumerator
DO_SA
DORA_SARR

Definition at line 104 of file command_options.h.

Member Function Documentation

◆ getAggressivity()

int isc::perfdhcp::CommandOptions::getAggressivity ( ) const

inline

Returns aggressivity value.

Returns: aggressivity value.

Definition at line 244 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::reset().

◆ getBase()

std::vector<std::string> isc::perfdhcp::CommandOptions::getBase ( ) const

inline

Returns base values.

Returns: all base values specified.

Definition at line 187 of file command_options.h.

◆ getClientsNum()

uint32_t isc::perfdhcp::CommandOptions::getClientsNum ( ) const

inline

Returns number of simulated clients.

Returns: number of simulated clients.

Definition at line 172 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::generateDuid(), isc::perfdhcp::TestControl::generateMacAddress(), and isc::perfdhcp::TestControl::run().

◆ getDiags()

std::string isc::perfdhcp::CommandOptions::getDiags ( ) const

inline

Returns diagnostic selectors.

Returns: diagnostics selector.

Definition at line 334 of file command_options.h.

Referenced by main().

◆ getDropTime()

std::vector<double> isc::perfdhcp::CommandOptions::getDropTime ( ) const

inline

Returns drop time.

The method returns maximum time elapsed from sending the packet before it is assumed dropped.

Returns: return time before request is assumed dropped.

Definition at line 205 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::initializeStatsMgr().

◆ getDuidTemplate()

std::vector<uint8_t> isc::perfdhcp::CommandOptions::getDuidTemplate ( ) const

inline

Returns DUID template.

Returns: DUID template to simulate different clients.

Definition at line 182 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::generateDuid(), and isc::perfdhcp::TestControl::printDiagnostics().

◆ getElapsedTimeOffset()

int isc::perfdhcp::CommandOptions::getElapsedTimeOffset ( ) const

inline

Returns template offset for elapsed time.

Returns: template offset for elapsed time.

Definition at line 319 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getElapsedTimeOffset().

◆ getExchangeMode()

ExchangeMode isc::perfdhcp::CommandOptions::getExchangeMode ( ) const

inline

Returns packet exchange mode.

Returns: packet exchange mode.

Definition at line 142 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::initializeStatsMgr(), isc::perfdhcp::TestControl::printRate(), isc::perfdhcp::TestControl::processReceivedPacket4(), and isc::perfdhcp::TestControl::processReceivedPacket6().

◆ getExitWaitTime()

int isc::perfdhcp::CommandOptions::getExitWaitTime ( ) const

inline

Returns the time in microseconds to delay the program by.

Returns: the time in microseconds to delay the program by.

Definition at line 254 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::waitToExit().

◆ getExtraOpts()

const isc::dhcp::OptionCollection& isc::perfdhcp::CommandOptions::getExtraOpts ( ) const

inline

Returns extra options to be inserted.

Returns: container with options

Definition at line 344 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::addExtraOpts().

◆ getIpVersion()

uint8_t isc::perfdhcp::CommandOptions::getIpVersion ( ) const

inline

Returns IP version.

Returns: IP version to be used.

Definition at line 137 of file command_options.h.

◆ getLeaseType()

LeaseType isc::perfdhcp::CommandOptions::getLeaseType ( ) const

inline

\ brief Returns the type of lease being requested.

Returns: type of lease being requested by perfdhcp.

Definition at line 147 of file command_options.h.

Referenced by printCommandLine().

◆ getLocalName()

std::string isc::perfdhcp::CommandOptions::getLocalName ( ) const

inline

Returns local address or interface name.

Returns: local address or interface name.

Definition at line 226 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::openSocket().

◆ getLocalPort()

int isc::perfdhcp::CommandOptions::getLocalPort ( ) const

inline

Returns local port number.

Returns: local port number.

Definition at line 249 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::openSocket(), and printCommandLine().

◆ getMacListFile()

std::string isc::perfdhcp::CommandOptions::getMacListFile ( ) const

inline

Returns location of the file containing list of MAC addresses.

MAC addresses read from the file are used by the perfdhcp in message exchanges with the DHCP server.

Returns: Location of the file containing list of MAC addresses.

Definition at line 297 of file command_options.h.

◆ getMacsFromFile()

const MacAddrsVector& isc::perfdhcp::CommandOptions::getMacsFromFile ( ) const

inline

Returns reference to a vector of MAC addresses read from a file.

Every MAC address is represented as a vector.

Returns: Reference to a vector of vectors.

Definition at line 304 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::generateDuid(), and isc::perfdhcp::TestControl::generateMacAddress().

◆ getMacTemplate()

std::vector<uint8_t> isc::perfdhcp::CommandOptions::getMacTemplate ( ) const

inline

Returns MAC address template.

Returns: MAC address template to simulate different clients.

Definition at line 177 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::generateMacAddress(), and isc::perfdhcp::TestControl::printDiagnostics().

◆ getMaxDrop()

std::vector<int> isc::perfdhcp::CommandOptions::getMaxDrop ( ) const

inline

Returns maximum drops number.

Returns maximum number of packet drops before aborting a test.

Returns: maximum number of dropped requests.

Definition at line 213 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::checkExitConditions().

◆ getMaxDropPercentage()

std::vector<double> isc::perfdhcp::CommandOptions::getMaxDropPercentage ( ) const

inline

Returns maximal percentage of drops.

Returns maximal percentage of packet drops before aborting a test.

Returns: maximum percentage of lost requests.

Definition at line 221 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::checkExitConditions().

◆ getNumRequests()

std::vector<int> isc::perfdhcp::CommandOptions::getNumRequests ( ) const

inline

Returns maximum number of exchanges.

Returns: number of exchange requests before test is aborted.

Definition at line 192 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::checkExitConditions(), and isc::perfdhcp::TestControl::haveAllPacketsBeenReceived().

◆ getPeriod()

int isc::perfdhcp::CommandOptions::getPeriod ( ) const

inline

Returns test period.

Returns: test period before it is aborted.

Definition at line 197 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::checkExitConditions().

◆ getPreload()

int isc::perfdhcp::CommandOptions::getPreload ( ) const

inline

Returns number of preload exchanges.

Returns: number of preload exchanges.

Definition at line 239 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::run().

◆ getRandomOffset()

std::vector<int> isc::perfdhcp::CommandOptions::getRandomOffset ( ) const

inline

Returns template offsets for rnd.

Returns: template offsets for rnd.

Definition at line 314 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getRandomOffset().

◆ getRate()

int isc::perfdhcp::CommandOptions::getRate ( ) const

inline

Returns exchange rate.

Returns: exchange rate per second.

Definition at line 152 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::printRate(), and isc::perfdhcp::TestControl::reset().

◆ getReleaseRate()

int isc::perfdhcp::CommandOptions::getReleaseRate ( ) const

inline

Returns a rate at which DHCPv6 Release messages are sent.

Returns: A rate at which DHCPv6 Release messages are sent.

Definition at line 162 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getCurrentTimeout(), isc::perfdhcp::TestControl::initializeStatsMgr(), printCommandLine(), isc::perfdhcp::TestControl::reset(), and isc::perfdhcp::TestControl::run().

◆ getRenewRate()

int isc::perfdhcp::CommandOptions::getRenewRate ( ) const

inline

Returns a rate at which DHCPv6 Renew messages are sent.

Returns: A rate at which IPv6 Renew messages are sent.

Definition at line 157 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::cleanCachedPackets(), isc::perfdhcp::TestControl::getCurrentTimeout(), isc::perfdhcp::TestControl::initializeStatsMgr(), printCommandLine(), isc::perfdhcp::TestControl::reset(), and isc::perfdhcp::TestControl::run().

◆ getReportDelay()

int isc::perfdhcp::CommandOptions::getReportDelay ( ) const

inline

Returns delay between two performance reports.

Returns: delay between two consecutive performance reports.

Definition at line 167 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::printIntermediateStats(), and isc::perfdhcp::TestControl::run().

◆ getRequestedIpOffset()

int isc::perfdhcp::CommandOptions::getRequestedIpOffset ( ) const

inline

Returns template offset for requested IP.

Returns: template offset for requested IP.

Definition at line 329 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getRequestedIpOffset().

◆ getSeed()

uint32_t isc::perfdhcp::CommandOptions::getSeed ( ) const

inline

Returns random seed.

Returns: random seed.

Definition at line 264 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::run().

◆ getServerIdOffset()

int isc::perfdhcp::CommandOptions::getServerIdOffset ( ) const

inline

Returns template offset for server-ID.

Returns: template offset for server-ID.

Definition at line 324 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getServerIdOffset().

◆ getServerName()

std::string isc::perfdhcp::CommandOptions::getServerName ( ) const

inline

Returns server name.

Returns: server name.

Definition at line 349 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::openSocket().

◆ getTemplateFiles()

std::vector<std::string> isc::perfdhcp::CommandOptions::getTemplateFiles ( ) const

inline

Returns template file names.

Returns: template file names.

Definition at line 289 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::initPacketTemplates().

◆ getTransactionIdOffset()

std::vector<int> isc::perfdhcp::CommandOptions::getTransactionIdOffset ( ) const

inline

brief Returns template offsets for xid.

Returns: template offsets for xid.

Definition at line 309 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::getTransactionIdOffset().

◆ getWrapped()

std::string isc::perfdhcp::CommandOptions::getWrapped ( ) const

inline

Returns wrapped command.

Returns: wrapped command (start/stop).

Definition at line 339 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::run(), and isc::perfdhcp::TestControl::runWrapped().

◆ instance()

CommandOptions & isc::perfdhcp::CommandOptions::instance ( )

static

CommandOptions is a singleton class.

This method returns reference to its sole instance.

Returns: the only existing instance of command options

Definition at line 99 of file command_options.cc.

◆ isBroadcast()

bool isc::perfdhcp::CommandOptions::isBroadcast ( ) const

inline

Checks if broadcast address is to be used.

Returns: true if broadcast address is to be used.

Definition at line 269 of file command_options.h.

◆ isInterface()

bool isc::perfdhcp::CommandOptions::isInterface ( ) const

inline

Checks if interface name was used.

The method checks if interface name was used rather than address.

Returns: true if interface name was used.

Definition at line 234 of file command_options.h.

◆ isRapidCommit()

bool isc::perfdhcp::CommandOptions::isRapidCommit ( ) const

inline

Check if rapid commit option used.

Returns: true if rapid commit option is used.

Definition at line 274 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::printRate().

◆ isSeeded()

bool isc::perfdhcp::CommandOptions::isSeeded ( ) const

inline

Checks if seed provided.

Returns: true if seed was provided.

Definition at line 259 of file command_options.h.

Referenced by isc::perfdhcp::TestControl::run().

◆ isUseFirst()

bool isc::perfdhcp::CommandOptions::isUseFirst ( ) const

inline

Check if server-ID to be taken from first package.

Returns: true if server-iD to be taken from first package.

Definition at line 279 of file command_options.h.

◆ isUseRelayedV6()

bool isc::perfdhcp::CommandOptions::isUseRelayedV6 ( ) const

inline

Check if generated DHCPv6 messages should appear as relayed.

Returns: true if generated traffic should appear as relayed.

Definition at line 284 of file command_options.h.

◆ parse()

bool isc::perfdhcp::CommandOptions::parse	(	int	argc,
		char **const	argv,
		bool	print_cmd_line = `false`
	)

Parse command line.

Parses the command line and stores the selected options in class data members.

Parameters

argc	Argument count passed to main().
argv	Argument value array passed to main().
print_cmd_line	Print the command line being run to the console.

Exceptions

isc::InvalidParameter if parse fails.

Returns: true if program has been run in help or version mode ('h' or 'v' flag).

Definition at line 161 of file command_options.cc.

References reset().

Referenced by main().

Here is the call graph for this function:

◆ printCommandLine()

void isc::perfdhcp::CommandOptions::printCommandLine ( ) const

Print command line arguments.

Definition at line 920 of file command_options.cc.

References DO_SA, getLeaseType(), getLocalPort(), getReleaseRate(), getRenewRate(), and isc::perfdhcp::CommandOptions::LeaseType::toText().

Referenced by isc::perfdhcp::TestControl::printDiagnostics().

Here is the call graph for this function:

◆ reset()

void isc::perfdhcp::CommandOptions::reset ( )

Reset to defaults.

Reset data members to default values. This is specifically useful when unit tests are performed using different command line options.

Definition at line 105 of file command_options.cc.

References isc::perfdhcp::CommandOptions::LeaseType::ADDRESS, DORA_SARR, and isc::perfdhcp::CommandOptions::LeaseType::set().

Referenced by parse().

Here is the call graph for this function:

◆ usage()

void isc::perfdhcp::CommandOptions::usage ( ) const

Print usage.

Prints perfdhcp usage.

Definition at line 1022 of file command_options.cc.

Referenced by main().

◆ version()

void isc::perfdhcp::CommandOptions::version ( ) const

Print program version.

Prints perfdhcp version.

Definition at line 1182 of file command_options.cc.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ MacAddrsVector

Member Enumeration Documentation

◆ ExchangeMode

Member Function Documentation

◆ getAggressivity()

◆ getBase()

◆ getClientsNum()

◆ getDiags()

◆ getDropTime()

◆ getDuidTemplate()

◆ getElapsedTimeOffset()

◆ getExchangeMode()

◆ getExitWaitTime()

◆ getExtraOpts()

◆ getIpVersion()

◆ getLeaseType()

◆ getLocalName()

◆ getLocalPort()

◆ getMacListFile()

◆ getMacsFromFile()

◆ getMacTemplate()

◆ getMaxDrop()

◆ getMaxDropPercentage()

◆ getNumRequests()

◆ getPeriod()

◆ getPreload()

◆ getRandomOffset()

◆ getRate()

◆ getReleaseRate()

◆ getRenewRate()

◆ getReportDelay()

◆ getRequestedIpOffset()

◆ getSeed()

◆ getServerIdOffset()

◆ getServerName()

◆ getTemplateFiles()

◆ getTransactionIdOffset()

◆ getWrapped()

◆ instance()

◆ isBroadcast()

◆ isInterface()

◆ isRapidCommit()

◆ isSeeded()

◆ isUseFirst()

◆ isUseRelayedV6()

◆ parse()

◆ printCommandLine()

◆ reset()

◆ usage()

◆ version()