campaignd::control_line Class Reference

Represents a server control line written to a communication socket. More...

#include <control.hpp>

Public Member Functions
	control_line (const std::string &str)
	Parses a control line string. More...
bool	empty () const
	Whether the control line is empty. More...
const std::string &	cmd () const
	Returns the control command. More...
std::size_t	args_count () const
	Returns the total number of arguments, not including the command itself. More...
const std::string &	operator[] (std::size_t n) const
	Returns the nth argument. More...
std::string	full () const
	Return the full command line string. More...
bool	operator== (std::string_view cmp) const
	Allow comparison with other strings. More...

Private Attributes
std::vector< std::string >	args_

Detailed Description

Represents a server control line written to a communication socket.

Control lines are plain text command lines using the ASCII space character (0x20) as command separator. This type is really only used to keep the code pretty.

Definition at line 33 of file control.hpp.

Constructor & Destructor Documentation

control_line()

campaignd::control_line::control_line ( const std::string &  str )

inlineexplicit

Parses a control line string.

Definition at line 39 of file control.hpp.

References args_.

Member Function Documentation

args_count()

std::size_t campaignd::control_line::args_count ( ) const

inline

Returns the total number of arguments, not including the command itself.

Definition at line 67 of file control.hpp.

References args_.

cmd()

const std::string& campaignd::control_line::cmd ( ) const

inline

Returns the control command.

Definition at line 59 of file control.hpp.

References args_.

Referenced by operator==().

empty()

bool campaignd::control_line::empty ( ) const

inline

Whether the control line is empty.

Definition at line 49 of file control.hpp.

References args_.

full()

std::string campaignd::control_line::full ( ) const

inline

Return the full command line string.

Definition at line 85 of file control.hpp.

References args_, and utils::join().

operator==()

bool campaignd::control_line::operator== ( std::string_view  cmp ) const

inline

Allow comparison with other strings.

Definition at line 93 of file control.hpp.

References cmd().

operator[]()

const std::string& campaignd::control_line::operator[] ( std::size_t  n ) const

inline

Returns the nth argument.

Exceptions

std::out_of_range

n exceeds args_count().

Definition at line 77 of file control.hpp.

References args_, and n.

Member Data Documentation

args_

std::vector<std::string> campaignd::control_line::args_

private

Definition at line 99 of file control.hpp.

Referenced by args_count(), cmd(), control_line(), empty(), full(), and operator[]().

---

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

• server/campaignd/control.hpp