Pigweed
C/C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pw::bluetooth_sapphire::NullLeaseProvider Class Referencefinal

A no-op LeaseProvider that always successfully returns an fake lease. More...

Inheritance diagram for pw::bluetooth_sapphire::NullLeaseProvider:
pw::bluetooth_sapphire::LeaseProvider

Public Member Functions

Result< LeaseAcquire (PW_SAPPHIRE_LEASE_TOKEN_TYPE) override
 
virtual Result< LeaseAcquire (PW_SAPPHIRE_LEASE_TOKEN_TYPE name)=0
 

Detailed Description

A no-op LeaseProvider that always successfully returns an fake lease.

Member Function Documentation

◆ Acquire()

Result< Lease > pw::bluetooth_sapphire::NullLeaseProvider::Acquire ( PW_SAPPHIRE_LEASE_TOKEN_TYPE  name)
inlineoverridevirtual

Try to acquire a lease. Prefer to use PW_SAPPHIRE_ACQUIRE_LEASE instead.

Parameters
namewill be either a const char* or a uint32_t depending on whether tokenization is enabled.
Returns
embed:rst:leading-asterisk
 
* 
*  .. pw-status-codes::
* 
*     OK: A `Lease` was successfully created and returned.
* 
*     UNAVAILABLE: A lease could not be created.
* 
*     INVALID_ARGUMENT: The name was invalid (e.g. empty).
* 
*  

Implements pw::bluetooth_sapphire::LeaseProvider.


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