Microsoft Information Protection SDK - Osservatori dell'API FileMicrosoft Information Protection SDK - File API Observers

L'API File contiene due classi osservatore.The File API contains two observer classes. I membri della classe osservatore sono virtuali e possono essere sottoposti a override per gestire i callback degli eventi.Observer members are virtual and can be overridden to handle event callbacks.

Al termine di un'operazione asincrona, viene chiamata la funzione membro OnXxx() corrispondente al risultato.When an asynchronous operation completes, the OnXxx() member function corresponding to the result is called. Sono esempi OnLoadSuccess(), OnLoadFailure() e OnAddEngineSuccess() per mip::FileProfile::Observer.Examples are OnLoadSuccess(), OnLoadFailure(), and OnAddEngineSuccess() for mip::FileProfile::Observer.

Gli esempi seguenti illustrano il modello promise/future, usato anche dagli esempi dell'SDK, e possono essere estesi per implementare il comportamento di callback desiderato.The examples below demonstrate the promise/future pattern, which is also used by the SDK samples, and can be extended to implement the desired callback behavior.

Implementazione dell'osservatore del profilo FileFile Profile Observer Implementation

Nell'esempio seguente è stata creata una classe ProfileObserver derivata da mip::FileProfile::Observer.In the following example, we've created a class, ProfileObserver that is derived from mip::FileProfile::Observer. Le funzioni membro sono state sottoposte a override per sfruttare il modello promise/future usato in tutti gli esempi.The member functions have been overridden to use the future/promise pattern used throughout the samples.

Nota: gli esempi di seguito sono implementati solo parzialmente e non includono gli override per gli osservatori correlati mip::FileEngine.Note: The below samples are only partially implemented and do not include overrides for the mip::FileEngine related observers.

profile_observer.hprofile_observer.h

Nell'intestazione si definisce ProfileObserver, che deriva da mip::FileProfile::Observer, quindi si esegue l'override di tutte le funzioni membro.In the header, we define ProfileObserver, deriving from mip::FileProfile::Observer, then override each of the member functions.

class ProfileObserver final : public mip::FileProfile::Observer {
public:
ProfileObserver() { }
  void OnLoadSuccess(const std::shared_ptr<mip::FileProfile>& profile, const std::shared_ptr<void>& context) override;
  void OnLoadFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) override;
  //TODO: Implement mip::FileEngine related observers.
};

profile_observer.cppprofile_observer.cpp

Nell'implementazione stessa si definisce un'azione da eseguire per ogni funzione membro dell'osservatore.In the implementation itself, we define an action to take for each observer member function.

Ogni membro accetta due parametri.Each member accepts two parameters. Il primo è un puntatore condiviso alla classe gestita nella funzione.The first is a shared pointer to the class we're handling in the function. ProfileObserver::OnLoadSuccess si aspetta di ricevere un mip::FileProfile.ProfileObserver::OnLoadSuccess would expect to receive a mip::FileProfile. ProfileObserver::OnAddEngineSuccess si aspetta mip::FileEngine.ProfileObserver::OnAddEngineSuccess would expect mip::FileEngine.

Il secondo è un puntatore condiviso al contesto.The second is a shared pointer to the context. In questa implementazione il contesto è un riferimento a std::promise, passato per riferimento come std::shared_ptr<void>.In our implementation, the context is a reference to a std::promise, passed by reference as std::shared_ptr<void>. La prima riga della funzione esegue il cast su std::promise, che viene poi archiviato in un oggetto denominato promise.The first line of the function casts this to std::promise, then stored in an object called promise.

Infine, l'elemento future viene preparato impostando promise->set_value() e passando l'oggetto mip::FileProfile.Finally, the future is made ready by setting the promise->set_value() and passing in the mip::FileProfile object.

#include "profile_observer.h"
#include <future>

//Called when FileProfile is successfully loaded
void ProfileObserver::OnLoadSuccess(const std::shared_ptr<mip::FileProfile>& profile, const std::shared_ptr<void>& context) {
  //cast context to promise
  auto promise = 
  std::static_pointer_cast<std::promise<std::shared_ptr<mip::FileProfile>>>(context);
  //set promise value to profile
  promise->set_value(profile);
}

//Called when FileProfile fails to load
void ProfileObserver::OnLoadFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) {
  auto promise = std::static_pointer_cast<std::promise<std::shared_ptr<mip::FileProfile>>>(context);
  promise->set_exception(error);
}

//TODO: Implement mip::FileEngine related observers.

Quando si crea un'istanza di qualsiasi classe dell'SDK o si usa una funzione che esegue operazioni asincrone, l'implementazione dell'osservatore verrà passata al costruttore delle impostazioni o alla funzione asincrona stessa.When we instantiate any SDK class or use a function that performs asynchronous operations, we will pass the observer implementation to the settings constructor or async function itself. Quando si creano istanze dell'oggetto mip::FileProfile::Settings, il costruttore accetta mip::FileProfile::Observer come uno dei parametri.When instantiating the mip::FileProfile::Settings object, the constructor takes in mip::FileProfile::Observer as one of the parameters. L'esempio seguente mostra l'implementazione personalizzata ProfileObserver, usata in un costruttore mip::FileProfile::Settings.The example below shows our custom ProfileObserver, used in a mip::FileProfile::Settings constructor.

Implementazione dell'osservatore FileHandlerFileHandler Observer Implementation

In modo analogo all'osservatore del profilo, mip::FileHandler implementa una classe mip::FileHandler::Observers per la gestione delle notifiche degli eventi asincroni durante le operazioni sui file.Similar to the profile observer, the mip::FileHandler implements a mip::FileHandler::Observers class for handling asynchronous event notifications during file operations. L'implementazione è simile a quella descritta in dettaglio in precedenza.The implementation is similar to that detailed above. L'implementazione FileHandlerObserver è definita parzialmente di seguito.FileHandlerObserver is partially defined below.

file_handler_observer.hfile_handler_observer.h

#include "mip/file/file_handler.h"

class FileHandlerObserver final : public mip::FileHandler::Observer {
public:
  void OnCreateFileHandlerSuccess(
      const std::shared_ptr<mip::FileHandler>& fileHandler,
      const std::shared_ptr<void>& context) override;

  void OnCreateFileHandlerFailure(
      const std::exception_ptr& error,
      const std::shared_ptr<void>& context) override;

  //TODO: override remaining member functions inherited from mip::FileHandler::Observer
};

file_handler_observer.cppfile_handler_observer.cpp

Questo esempio riguarda solo le prime due funzioni, ma le funzioni rimanenti usano un modello simile per queste implementazioni e per ProfileObserver.This sample is just the first two functions, but the remaining functions use a similar pattern to these and to ProfileObserver.

#include "file_handler_observer.h"

void FileHandlerObserver::OnCreateFileHandlerSuccess(const std::shared_ptr<mip::FileHandler>& fileHandler, const std::shared_ptr<void>& context) {
    auto promise = std::static_pointer_cast<std::promise<std::shared_ptr<mip::FileHandler>>>(context);
    promise->set_value(fileHandler);
}

void FileHandlerObserver::OnCreateFileHandlerFailure(const std::exception_ptr& error, const std::shared_ptr<void>& context) {
    auto promise = std::static_pointer_cast<std::promise<std::shared_ptr<mip::FileHandler>>>(context);
    promise->set_exception(error);
}

//TODO: override remaining member functions inherited from mip::FileHandler::Observer