EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EPCDNS::AppProtocol Class Reference

Application protocol object. More...

#include <epcdns.h>

Public Member Functions

 AppProtocol ()
 Default constructor. More...
 
 ~AppProtocol ()
 Class destructor. More...
 
const EStringgetRawProtocol ()
 Retrieves the raw protocol string. More...
 
AppProtocolEnum getProtocol ()
 Retrieves the protocol enumeration. More...
 
UsageTypeListgetUsageTypes ()
 Retrieves the list of usage types. More...
 
NetworkCapabilityListgetNetworkCapabilities ()
 Retrieves the list of network capabilities. More...
 
AppProtocolEnum setProtocol (AppProtocolEnum ape)
 Assigns the protocol enumeration. More...
 
UsageType addUsageType (UsageType ut)
 Adds a usage type object to the usage type list. More...
 
NetworkCapability & addNetworkCapability (NetworkCapability &nc)
 Adds a network capability to the network capability list. More...
 
Void parse (const std::string &rp)
 Parses any usage types and network capabilities. More...
 
Bool findUsageType (UsageType ut)
 Determines if a usage type exists in the usage type list. More...
 
Bool findNetworkCapability (const NetworkCapability &nc)
 Determines if a network capability exists in the network capabilities list. More...
 
Void dump (const char *prefix="")
 Prints the contents of this object. More...
 

Detailed Description

Application protocol object.

Constructor & Destructor Documentation

◆ AppProtocol()

EPCDNS::AppProtocol::AppProtocol ( )
inline

Default constructor.

◆ ~AppProtocol()

EPCDNS::AppProtocol::~AppProtocol ( )
inline

Class destructor.

Member Function Documentation

◆ addNetworkCapability()

NetworkCapability& EPCDNS::AppProtocol::addNetworkCapability ( NetworkCapability &  nc)
inline

Adds a network capability to the network capability list.

Parameters
ncthe network capability to add.
Returns
the network capability added.

◆ addUsageType()

UsageType EPCDNS::AppProtocol::addUsageType ( UsageType  ut)
inline

Adds a usage type object to the usage type list.

Parameters
utthe usage type to add.
Returns
the added usage type.

◆ dump()

Void EPCDNS::AppProtocol::dump ( const char *  prefix = "")
inline

Prints the contents of this object.

Parameters
prefixa value to prepend to each line.

◆ findNetworkCapability()

Bool EPCDNS::AppProtocol::findNetworkCapability ( const NetworkCapability &  nc)
inline

Determines if a network capability exists in the network capabilities list.

Parameters
ncthe network capability to search for.
Returns
True if the network capability exists, otherwise False.

◆ findUsageType()

Bool EPCDNS::AppProtocol::findUsageType ( UsageType  ut)
inline

Determines if a usage type exists in the usage type list.

Parameters
utthe usage type to search for.
Returns
True if the usage type exists, otherwise False.

◆ getNetworkCapabilities()

NetworkCapabilityList& EPCDNS::AppProtocol::getNetworkCapabilities ( )
inline

Retrieves the list of network capabilities.

Returns
the list of network capabilities.

◆ getProtocol()

AppProtocolEnum EPCDNS::AppProtocol::getProtocol ( )
inline

Retrieves the protocol enumeration.

Returns
the protocol enumeration.

◆ getRawProtocol()

const EString& EPCDNS::AppProtocol::getRawProtocol ( )
inline

Retrieves the raw protocol string.

Returns
the raw protocol string.

◆ getUsageTypes()

UsageTypeList& EPCDNS::AppProtocol::getUsageTypes ( )
inline

Retrieves the list of usage types.

Returns
the list of usage types.

◆ parse()

Void AppProtocol::parse ( const std::string &  rp)

Parses any usage types and network capabilities.

Parameters
rpthe string to parse.

◆ setProtocol()

AppProtocolEnum EPCDNS::AppProtocol::setProtocol ( AppProtocolEnum  ape)
inline

Assigns the protocol enumeration.

Parameters
apethe protocol enumeration.
Returns
the protocol enumeration.

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