dca_interface  6.3.4
dca_ipr::IprClassifier Class Reference

#include <ipr_classifier.h>

Detailed Description

Defintion of the IprClassifier class.

The classfier takes a dca_ipr::Ip object and performs a classification of the given IP address.

The result of the classification is stored in the IprClassificationResults object and the overall success is returned in the dca::FunctionResult (success or failure and details).

An IprClassifier can be obtained from an IprClassification instance.

See also
IprClassification, Ip, IprClassificationResult

Definition at line 33 of file ipr_classifier.h.

Public Member Functions

dca::FunctionResult classify (const Ip &input, IprClassificationResults &result) const
 Classification function that takes the given input and returns the results (if any) in the provided result object. More...
 

Member Function Documentation

◆ classify()

dca::FunctionResult dca_ipr::IprClassifier::classify ( const Ip input,
IprClassificationResults result 
) const

Classification function that takes the given input and returns the results (if any) in the provided result object.

Parameters
[in]inputAn initialized IP input data object
[out]resultIf classification was successful the result contains the matched categories
Returns
DCA_SUCCESS or one of the following error codes
See also
IprClassification, Ip, Ipv4, Ipv6, IprClassificationResult, dca::FunctionResult

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