openvpn::PushLex Class Reference

#include <pushlex.hpp>

Collaboration diagram for openvpn::PushLex:

Public Member Functions
	OPENVPN_EXCEPTION (pushlex_error)
	PushLex (const ConstBuffer &buf, const bool discard_prefix)
bool	defined () const
std::string	next ()

Private Attributes
ConstBuffer	buf_

Detailed Description

Class PushLex is used to parse out the individual options in a comma-separated push options list.

Definition at line 24 of file pushlex.hpp.

Constructor & Destructor Documentation

PushLex()

openvpn::PushLex::PushLex ( const ConstBuffer &  buf, const bool  discard_prefix  )

inline

Setup parsing iterator for comma-separated push options list.

Parameters

buf	Contains the comma-separated push options list.
discard_prefix	If the list begins with a "PUSH_REPLY" or "PUSH_UPDATE" prefix, discard the prefix.

Definition at line 36 of file pushlex.hpp.

Member Function Documentation

defined()

bool openvpn::PushLex::defined ( ) const

inline

Use in iterator loop to determine if more options are still available to be fetched with next().

Returns

true if next() may be called to return next option.

Definition at line 61 of file pushlex.hpp.

Here is the caller graph for this function:

next()

std::string openvpn::PushLex::next ( )

inline

Use in iterator loop to fetch next option.

Returns

next option.

Definition at line 71 of file pushlex.hpp.

Here is the caller graph for this function:

OPENVPN_EXCEPTION()

openvpn::PushLex::OPENVPN_EXCEPTION

(

pushlex_error

)

Member Data Documentation

buf_

ConstBuffer openvpn::PushLex::buf_

private

Definition at line 87 of file pushlex.hpp.

---

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

• openvpn/options/pushlex.hpp