PcapPlusPlus  24.09
pcpp::LdapSearchRequestLayer::SearchRequestScope Class Reference

#include <LdapLayer.h>

Public Types

enum  Value : uint8_t {
  BaseObject = 0 , SingleLevel = 1 , WholeSubtree = 2 , subordinateSubtree = 3 ,
  Unknown = 255
}
 

Public Member Functions

constexpr SearchRequestScope (Value value)
 
std::string toString () const
 

Static Public Member Functions

static SearchRequestScope fromUintValue (uint8_t value)
 

Detailed Description

An enum wrapper class for LDAP search request scope

Member Enumeration Documentation

◆ Value

Define enum types and the corresponding int values

Enumerator
BaseObject 

The search operation should only be performed against the entry specified as the search base DN

SingleLevel 

The search operation should only be performed against entries that are immediate subordinates of the entry specified as the search base DN

WholeSubtree 

The search operation should be performed against the entry specified as the search base and all of its subordinates to any depth

subordinateSubtree 

The search operation should be performed against any subordinate entries (to any depth) below the entry specified by the base DN should be considered, but the base entry itself should not be considered

Unknown 

Unknown or unsupported scope

Constructor & Destructor Documentation

◆ SearchRequestScope()

constexpr pcpp::LdapSearchRequestLayer::SearchRequestScope::SearchRequestScope ( Value  value)
inlineconstexpr

Construct SearchRequestScope from Value enum

Parameters
[in]valuethe scope enum value

Member Function Documentation

◆ fromUintValue()

static SearchRequestScope pcpp::LdapSearchRequestLayer::SearchRequestScope::fromUintValue ( uint8_t  value)
static

A static method that creates SearchRequestScope from an integer value

Parameters
[in]valueThe scope integer value
Returns
The scope that corresponds to the integer value. If the integer value doesn't corresponds to any enum value, SearchRequestScope::Unknown is returned

◆ toString()

std::string pcpp::LdapSearchRequestLayer::SearchRequestScope::toString ( ) const
Returns
A string representation of the scope value