Kanzi Connect  3.9.8
Kanzi Connect C++ API
kanzi::connect::messagefilter::Result Class Reference

Stores result of message filtering action. More...

#include <service_message_filter.hpp>

Public Types

enum  Status { Pass, Decline }
 
typedef enum kanzi::connect::messagefilter::Result::Status Status
 

Public Member Functions

int getDeclinedRule () const
 Get the # of rule that declined the message. More...
 
Status getStatus () const
 The status of operation. More...
 
 Result (Status status=Pass, int declinedRule=0)
 C++ constructor - initialize object. More...
 
void setStatus (Status verdict, int ruleId)
 

Detailed Description

Stores result of message filtering action.

Member Typedef Documentation

◆ Status

Member Enumeration Documentation

◆ Status

Enumerator
Pass 

Pass the message through.

Decline 

Decline message delivery.

Constructor & Destructor Documentation

◆ Result()

kanzi::connect::messagefilter::Result::Result ( Status  status = Pass,
int  declinedRule = 0 
)

C++ constructor - initialize object.

Parameters
statusinitialization status
declinedRulethe rule (index of it) that declined the message.

Member Function Documentation

◆ getDeclinedRule()

int kanzi::connect::messagefilter::Result::getDeclinedRule ( ) const

Get the # of rule that declined the message.

Returns
index to policy rule.

◆ getStatus()

Status kanzi::connect::messagefilter::Result::getStatus ( ) const

The status of operation.

Returns
status of operation.

◆ setStatus()

void kanzi::connect::messagefilter::Result::setStatus ( Status  verdict,
int  ruleId 
)

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