Direct-BT v3.3.0-1-gc2d430c
Direct-BT - Direct Bluetooth Programming.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
direct_bt::MgmtDefaultParam Struct Reference
Direct-BT System Level API

Used in MgmtReadDefaultSysParamCmd and MgmtSetDefaultConnParamCmd. More...

#include <MgmtTypes.hpp>

Collaboration diagram for direct_bt::MgmtDefaultParam:

Public Types

enum class  Type : uint16_t {
  BREDR_PAGE_SCAN_TYPE = 0x0000 , BREDR_PAGE_SCAN_INTERVAL = 0x0001 , BREDR_PAGE_SCAN_WINDOW = 0x0002 , BREDR_INQUIRY_TYPE = 0x0003 ,
  BREDR_INQUIRY_INTERVAL = 0x0004 , BREDR_INQUIRY_WINDOW = 0x0005 , BREDR_LINK_SUPERVISOR_TIMEOUT = 0x0006 , BREDR_PAGE_TIMEOUT = 0x0007 ,
  BREDR_MIN_SNIFF_INTERVAL = 0x0008 , BREDR_MAX_SNIFF_INTERVAL = 0x0009 , LE_ADV_MIN_INTERVAL = 0x000a , LE_ADV_MAX_INTERVAL = 0x000b ,
  LE_MULTI_ADV_ROT_INTERVAL = 0x000c , LE_SCAN_INTERVAL_AUTOCONN = 0x000d , LE_SCAN_WINDOW_AUTOCONN = 0x000e , LE_SCAN_INTERVAL_WAKESCENARIO = 0x000f ,
  LE_SCAN_WINDOW_WAKESCENARIO = 0x0010 , LE_SCAN_INTERVAL_DISCOVERY = 0x0011 , LE_SCAN_WINDOW_DISCOVERY = 0x0012 , LE_SCAN_INTERVAL_ADVMON = 0x0013 ,
  LE_SCAN_WINDOW_ADVMON = 0x0014 , LE_SCAN_INTERVAL_CONNECT = 0x0015 , LE_SCAN_WINDOW_CONNECT = 0x0016 , LE_MIN_CONN_INTERVAL = 0x0017 ,
  LE_MAX_CONN_INTERVAL = 0x0018 , LE_CONN_LATENCY = 0x0019 , LE_CONN_SUPERVISOR_TIMEOUT = 0x001a , LE_AUTOCONN_TIMEOUT = 0x001b ,
  NONE = 0xffff
}
 

Public Member Functions

 MgmtDefaultParam () noexcept
 
 MgmtDefaultParam (const MgmtDefaultParam &o)=default
 
 MgmtDefaultParam (const Type type_) noexcept
 
 MgmtDefaultParam (const Type type_, const uint16_t value_) noexcept
 
 MgmtDefaultParam (MgmtDefaultParam &&o)=default
 
jau::nsize_t mgmt_size () const
 Mgmt size, i.e. More...
 
jau::nsize_t net_size () const
 Net size, i.e. More...
 
MgmtDefaultParam & operator= (const MgmtDefaultParam &o)=default
 
MgmtDefaultParam & operator= (MgmtDefaultParam &&o)=default
 
void put_nc (jau::TOctets &dest, const jau::nsize_t offset) const
 Transfer bytes to dest, both in little endian format. More...
 
std::string toString () const noexcept
 
bool valid () const
 
std::string valueToString () const noexcept
 

Static Public Member Functions

static std::string getTypeString (const Type op) noexcept
 
static constexpr uint16_t number (const Type rhs) noexcept
 
static MgmtDefaultParam read (const uint8_t *data, const jau::nsize_t length) noexcept
 
static uint8_t to_size (const Type type) noexcept
 

Public Attributes

Type type
 2 octets for type: [0x0000 - 0x001e], etc. More...
 
jau::POctets value
 value store More...
 

Static Public Attributes

static constexpr const jau::nsize_t uint16_size = 2 + 1 + 2
 

Detailed Description

Used in MgmtReadDefaultSysParamCmd and MgmtSetDefaultConnParamCmd.

Definition at line 1237 of file MgmtTypes.hpp.

Member Enumeration Documentation

◆ Type

enum class direct_bt::MgmtDefaultParam::Type : uint16_t
strong
Enumerator
BREDR_PAGE_SCAN_TYPE 
BREDR_PAGE_SCAN_INTERVAL 
BREDR_PAGE_SCAN_WINDOW 
BREDR_INQUIRY_TYPE 
BREDR_INQUIRY_INTERVAL 
BREDR_INQUIRY_WINDOW 
BREDR_LINK_SUPERVISOR_TIMEOUT 
BREDR_PAGE_TIMEOUT 
BREDR_MIN_SNIFF_INTERVAL 
BREDR_MAX_SNIFF_INTERVAL 
LE_ADV_MIN_INTERVAL 
LE_ADV_MAX_INTERVAL 
LE_MULTI_ADV_ROT_INTERVAL 
LE_SCAN_INTERVAL_AUTOCONN 
LE_SCAN_WINDOW_AUTOCONN 
LE_SCAN_INTERVAL_WAKESCENARIO 
LE_SCAN_WINDOW_WAKESCENARIO 
LE_SCAN_INTERVAL_DISCOVERY 
LE_SCAN_WINDOW_DISCOVERY 
LE_SCAN_INTERVAL_ADVMON 
LE_SCAN_WINDOW_ADVMON 
LE_SCAN_INTERVAL_CONNECT 
LE_SCAN_WINDOW_CONNECT 
LE_MIN_CONN_INTERVAL 
LE_MAX_CONN_INTERVAL 
LE_CONN_LATENCY 
LE_CONN_SUPERVISOR_TIMEOUT 
LE_AUTOCONN_TIMEOUT 
NONE 

Definition at line 1238 of file MgmtTypes.hpp.

Constructor & Destructor Documentation

◆ MgmtDefaultParam() [1/5]

direct_bt::MgmtDefaultParam::MgmtDefaultParam ( )
inlinenoexcept

Definition at line 1288 of file MgmtTypes.hpp.

◆ MgmtDefaultParam() [2/5]

direct_bt::MgmtDefaultParam::MgmtDefaultParam ( const Type  type_)
inlinenoexcept

Definition at line 1291 of file MgmtTypes.hpp.

◆ MgmtDefaultParam() [3/5]

direct_bt::MgmtDefaultParam::MgmtDefaultParam ( const Type  type_,
const uint16_t  value_ 
)
inlinenoexcept

Definition at line 1294 of file MgmtTypes.hpp.

◆ MgmtDefaultParam() [4/5]

direct_bt::MgmtDefaultParam::MgmtDefaultParam ( const MgmtDefaultParam &  o)
default

◆ MgmtDefaultParam() [5/5]

direct_bt::MgmtDefaultParam::MgmtDefaultParam ( MgmtDefaultParam &&  o)
default

Member Function Documentation

◆ number()

static constexpr uint16_t direct_bt::MgmtDefaultParam::number ( const Type  rhs)
inlinestaticconstexprnoexcept

Definition at line 1271 of file MgmtTypes.hpp.

◆ getTypeString()

std::string MgmtDefaultParam::getTypeString ( const Type  op)
staticnoexcept

Definition at line 296 of file MgmtTypes.cpp.

◆ to_size()

static uint8_t direct_bt::MgmtDefaultParam::to_size ( const Type  type)
inlinestaticnoexcept

Definition at line 1276 of file MgmtTypes.hpp.

◆ read()

MgmtDefaultParam MgmtDefaultParam::read ( const uint8_t *  data,
const jau::nsize_t  length 
)
staticnoexcept

Definition at line 304 of file MgmtTypes.cpp.

Here is the caller graph for this function:

◆ operator=() [1/2]

MgmtDefaultParam & direct_bt::MgmtDefaultParam::operator= ( const MgmtDefaultParam &  o)
default

◆ operator=() [2/2]

MgmtDefaultParam & direct_bt::MgmtDefaultParam::operator= ( MgmtDefaultParam &&  o)
default

◆ valid()

bool direct_bt::MgmtDefaultParam::valid ( ) const
inline

Definition at line 1311 of file MgmtTypes.hpp.

Here is the caller graph for this function:

◆ net_size()

jau::nsize_t direct_bt::MgmtDefaultParam::net_size ( ) const
inline

Net size, i.e.

sizeof(Type) + value-octets = 2 + value-octets

Definition at line 1314 of file MgmtTypes.hpp.

◆ mgmt_size()

jau::nsize_t direct_bt::MgmtDefaultParam::mgmt_size ( ) const
inline

Mgmt size, i.e.

sizeof(Type) + sizeof(value_length) + value-octets = 2 + 1 + value-octets

Definition at line 1317 of file MgmtTypes.hpp.

Here is the caller graph for this function:

◆ put_nc()

void direct_bt::MgmtDefaultParam::put_nc ( jau::TOctets &  dest,
const jau::nsize_t  offset 
) const
inline

Transfer bytes to dest, both in little endian format.

Definition at line 1320 of file MgmtTypes.hpp.

Here is the caller graph for this function:

◆ valueToString()

std::string direct_bt::MgmtDefaultParam::valueToString ( ) const
inlinenoexcept

Definition at line 1326 of file MgmtTypes.hpp.

◆ toString()

std::string direct_bt::MgmtDefaultParam::toString ( ) const
inlinenoexcept

Definition at line 1332 of file MgmtTypes.hpp.

Member Data Documentation

◆ uint16_size

constexpr const jau::nsize_t direct_bt::MgmtDefaultParam::uint16_size = 2 + 1 + 2
staticconstexpr

Definition at line 1284 of file MgmtTypes.hpp.

◆ type

Type direct_bt::MgmtDefaultParam::type

2 octets for type: [0x0000 - 0x001e], etc.

Definition at line 1307 of file MgmtTypes.hpp.

◆ value

jau::POctets direct_bt::MgmtDefaultParam::value

value store

Definition at line 1309 of file MgmtTypes.hpp.

The documentation for this struct was generated from the following files:
Generated on Sun May 12 2024 09:25:38 for Direct-BT by doxygen 1.9.4