medcrypt::guardian::TransportInterface

Service::ConfigureTransport required interface.

#include <TransportInterface.h>

Public Functions

	Name
virtual	~TransportInterface()
virtual Status	ApplySecurity(const std::unique_ptr< medcrypt::guardian::utilities::SafeString > & in_parameters) =0 Security parameters receiver.

Public Functions Documentation

function ~TransportInterface

inline virtual ~TransportInterface()

function ApplySecurity

virtual Status ApplySecurity(
    const std::unique_ptr< medcrypt::guardian::utilities::SafeString > & in_parameters
) =0

Security parameters receiver.

Parameters:

• in_parameters implementation dependent encoding of security parameters

Returns:

• OK successfully applied security

• other any non zero failure code

Return: medcrypt::guardian::Status

The contents of in_parameters are dependent on the type of transport implemented by the derived class.

An implemented ApplySecurity function should return GuardianStatusEnum::OK on success, and a non zero derivation defined code on failure.

The SafeString type can be treated as a normal std::string.

Debugging and logging

Guardian does not create log files. Instead, logging is controlled by the application:

• Guardian logs to stdout and stderr, which appear in the terminal/CLI of the running application during execution. Look for specific error codes or connection failures in the output.

• Custom logging: Use SetLoggingCallback to redirect log messages to a callback function, stopping terminal output and allowing custom log handling

• Log control: Applications can control log level and verbosity.

• Guardian Cloud UI: Check the Guardian Cloud interface for additional error details and provisioning status.