ELEC-C7222
Libraries for ELEC C7222 Course Work
Loading...
Searching...
No Matches
c7222::SecurityManager::EventHandler Struct Reference

Security Manager event callback interface. More...

#include <security_manager.hpp>

Inheritance diagram for c7222::SecurityManager::EventHandler:
Inheritance graph
Collaboration diagram for c7222::SecurityManager::EventHandler:
Collaboration graph

Public Member Functions

virtual void OnJustWorksRequest (ConnectionHandle connection_handle) const
 Called when "Just Works" confirmation is requested.
 
virtual void OnNumericComparisonRequest (ConnectionHandle connection_handle, uint32_t numeric_value) const
 Called when numeric comparison is requested.
 
virtual void OnPasskeyDisplay (ConnectionHandle connection_handle, uint32_t passkey) const
 Called when the stack requests passkey display.
 
virtual void OnPasskeyInput (ConnectionHandle connection_handle) const
 Called when the stack requests passkey input.
 
virtual void OnPairingComplete (ConnectionHandle connection_handle, PairingStatus status, uint8_t status_code) const
 Called when pairing completes.
 
virtual void OnReencryptionComplete (ConnectionHandle connection_handle, uint8_t status_code) const
 Called when re-encryption completes.
 
virtual void OnAuthorizationRequest (ConnectionHandle connection_handle) const
 Called when authorization is required.
 
virtual void OnAuthorizationResult (ConnectionHandle connection_handle, AuthorizationResult result) const
 Called when an authorization decision is available.
 

Protected Member Functions

 ~EventHandler ()=default
 

Detailed Description

Security Manager event callback interface.

Event data references are only valid during the callback.

Constructor & Destructor Documentation

◆ ~EventHandler()

c7222::SecurityManager::EventHandler::~EventHandler ( )
protecteddefault

Member Function Documentation

◆ OnAuthorizationRequest()

virtual void c7222::SecurityManager::EventHandler::OnAuthorizationRequest ( ConnectionHandle  connection_handle) const
inlinevirtual

Called when authorization is required.

Parameters
connection_handleConnection requesting authorization.

Reimplemented in SecurityEventHandler.

◆ OnAuthorizationResult()

virtual void c7222::SecurityManager::EventHandler::OnAuthorizationResult ( ConnectionHandle  connection_handle,
AuthorizationResult  result 
) const
inlinevirtual

Called when an authorization decision is available.

Parameters
connection_handleConnection associated with the decision.
resultAuthorization decision for the connection.

Reimplemented in SecurityEventHandler.

◆ OnJustWorksRequest()

virtual void c7222::SecurityManager::EventHandler::OnJustWorksRequest ( ConnectionHandle  connection_handle) const
inlinevirtual

Called when "Just Works" confirmation is requested.

Parameters
connection_handleConnection on which pairing is requested.

Reimplemented in SecurityEventHandler.

◆ OnNumericComparisonRequest()

virtual void c7222::SecurityManager::EventHandler::OnNumericComparisonRequest ( ConnectionHandle  connection_handle,
uint32_t  numeric_value 
) const
inlinevirtual

Called when numeric comparison is requested.

Parameters
connection_handleConnection associated with the request.
numeric_value6-digit numeric comparison value to confirm.

Reimplemented in SecurityEventHandler.

◆ OnPairingComplete()

virtual void c7222::SecurityManager::EventHandler::OnPairingComplete ( ConnectionHandle  connection_handle,
PairingStatus  status,
uint8_t  status_code 
) const
inlinevirtual

Called when pairing completes.

Parameters
connection_handleConnection for which pairing completed.
statusHigh-level pairing status.
status_codeStack-specific status value.

Reimplemented in SecurityEventHandler.

◆ OnPasskeyDisplay()

virtual void c7222::SecurityManager::EventHandler::OnPasskeyDisplay ( ConnectionHandle  connection_handle,
uint32_t  passkey 
) const
inlinevirtual

Called when the stack requests passkey display.

Parameters
connection_handleConnection on which passkey display is required.
passkeyPasskey value that should be shown to the user.

Reimplemented in SecurityEventHandler.

◆ OnPasskeyInput()

virtual void c7222::SecurityManager::EventHandler::OnPasskeyInput ( ConnectionHandle  connection_handle) const
inlinevirtual

Called when the stack requests passkey input.

Parameters
connection_handleConnection on which passkey entry is required.

Reimplemented in SecurityEventHandler.

◆ OnReencryptionComplete()

virtual void c7222::SecurityManager::EventHandler::OnReencryptionComplete ( ConnectionHandle  connection_handle,
uint8_t  status_code 
) const
inlinevirtual

Called when re-encryption completes.

Parameters
connection_handleConnection for which re-encryption completed.
status_codeStack-specific re-encryption status code.

Reimplemented in SecurityEventHandler.


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