Botan::TPM2::ObjectSetter Class Reference

#include <tpm2_util.h>

Public Member Functions
	ObjectSetter (const ObjectSetter &)=delete
constexpr	ObjectSetter (Object &object, bool persistent=false)
	ObjectSetter (ObjectSetter &&)=delete
constexpr	operator uint32_t * () &&noexcept
ObjectSetter &	operator= (const ObjectSetter &)=delete
ObjectSetter &	operator= (ObjectSetter &&)=delete
constexpr	~ObjectSetter () noexcept

Detailed Description

Helper type setting a TPM2_HANDLE or ESYS_TR on a given instance of Object from a TSS2 library function's out parameter.

This is not used directly, but through the out_transient_handle() and out_persistent_handle() respectively.

Definition at line 183 of file tpm2_util.h.

Constructor & Destructor Documentation

ObjectSetter() [1/3]

Botan::TPM2::ObjectSetter::ObjectSetter ( Object & object, bool persistent = false )

inlineexplicitconstexpr

Definition at line 185 of file tpm2_util.h.

                                                                               :
            m_object(object), m_persistent(persistent), m_handle(persistent ? 0 : ESYS_TR_NONE) {}

~ObjectSetter()

Botan::TPM2::ObjectSetter::~ObjectSetter ( )

inlineconstexprnoexcept

Definition at line 188 of file tpm2_util.h.

                                         {
         if(!was_written()) {
            return;
         }
 
         if(m_persistent) {
            m_object.handles().persistent = m_handle;
         } else {
            m_object.handles().transient = m_handle;
         }
      }

References Botan::TPM2::ObjectHandles::persistent, and Botan::TPM2::ObjectHandles::transient.

ObjectSetter() [2/3]

Botan::TPM2::ObjectSetter::ObjectSetter ( const ObjectSetter & )

delete

ObjectSetter() [3/3]

Botan::TPM2::ObjectSetter::ObjectSetter ( ObjectSetter && )

delete

Member Function Documentation

operator uint32_t *()

Botan::TPM2::ObjectSetter::operator uint32_t * ( ) &&

inlinenodiscardconstexprnoexcept

Definition at line 206 of file tpm2_util.h.

{ return &m_handle; }

operator=() [1/2]

ObjectSetter & Botan::TPM2::ObjectSetter::operator= ( const ObjectSetter & )

delete

operator=() [2/2]

ObjectSetter & Botan::TPM2::ObjectSetter::operator= ( ObjectSetter && )

delete

---

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

• src/lib/prov/tpm2/tpm2_util.h