winget-cli

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

ClientConfig.h (1212B)


      1 // Copyright (c) Microsoft Corporation.
      2 // Licensed under the MIT License.
      3 
      4 #pragma once
      5 
      6 #include "Logging.h"
      7 
      8 #include <optional>
      9 #include <string>
     10 
     11 namespace SFS
     12 {
     13 /// @brief Configurations to create an SFSClient instance
     14 struct ClientConfig
     15 {
     16     /// @brief The account ID of the SFS service is used to identify the caller (required)
     17     std::string accountId;
     18 
     19     /// @brief The instance ID of the SFS service
     20     std::optional<std::string> instanceId;
     21 
     22     /// @brief The namespace of the SFS service
     23     std::optional<std::string> nameSpace;
     24 
     25     /**
     26      * @brief A logging callback function that is called when the SFSClient logs a message
     27      * @details This function returns logging information from the SFSClient. The caller is responsible for incoporating
     28      * the received data into their logging system. The callback will be called in the same thread as the
     29      * main flow, so make sure the callback does not block for too long so it doesn't delay operations. The
     30      * LogData does not exist after the callback returns, so caller has to copy it if the data will be stored.
     31      */
     32     std::optional<LoggingCallbackFn> logCallbackFn;
     33 };
     34 } // namespace SFS