AsyncPluginValidator::Impl Class Reference

Inheritance diagram for AsyncPluginValidator::Impl:

Collaboration diagram for AsyncPluginValidator::Impl:

Public Member Functions
	Impl (Impl &)=delete
	Impl (Impl &&)=delete
Impl &	operator= (Impl &)=delete
Impl &	operator= (Impl &&)=delete
	Impl (Delegate &delegate)
	~Impl () override
void	SetDelegate (Delegate *delegate)
std::chrono::system_clock::time_point	InactiveSince () const noexcept
void	OnConnect (IPCChannel &channel) noexcept override
	Called when connection established. More...
void	OnDisconnect () noexcept override
	Invalidates IPCChannel passed as argument in OnConnect. More...
void	OnConnectionError () noexcept override
	Called when connection attempt fails. More...
void	OnDataAvailable (const void *data, size_t size) noexcept override
	Called when data chunk received as a result of a preceding call to IPCChannel::Send. Generally, data pointer should not be accessed outside this method, copied if necessary. More...
void	Validate (const wxString &providerId, const wxString &pluginPath)
Public Member Functions inherited from IPCChannelStatusCallback
virtual	~IPCChannelStatusCallback ()
virtual void	OnConnectionError () noexcept=0
	Called when connection attempt fails. More...
virtual void	OnConnect (IPCChannel &channel) noexcept=0
	Called when connection established. More...
virtual void	OnDisconnect () noexcept=0
	Invalidates IPCChannel passed as argument in OnConnect. More...
virtual void	OnDataAvailable (const void *data, size_t size) noexcept=0
	Called when data chunk received as a result of a preceding call to IPCChannel::Send. Generally, data pointer should not be accessed outside this method, copied if necessary. More...

Private Member Functions
void	StartHost ()
void	HandleInternalError (const wxString &msg) noexcept
void	HandleResult (detail::PluginValidationResult &&result) noexcept

Private Attributes
IPCChannel *	mChannel {nullptr}
std::optional< wxString >	mRequest
std::atomic< std::chrono::system_clock::duration::rep >	mLastTimeActive
spinlock	mSync
Delegate *	mDelegate {nullptr}
std::unique_ptr< IPCServer >	mServer
detail::InputMessageReader	mMessageReader

Detailed Description

Definition at line 31 of file AsyncPluginValidator.cpp.

Constructor & Destructor Documentation

Impl() [1/3]

AsyncPluginValidator::Impl::Impl ( Impl &  )

delete

Impl() [2/3]

AsyncPluginValidator::Impl::Impl ( Impl &&  )

delete

Impl() [3/3]

AsyncPluginValidator::Impl::Impl ( Delegate &  delegate )

inline

Definition at line 138 of file AsyncPluginValidator.cpp.

: mDelegate(&delegate) { }

~Impl()

AsyncPluginValidator::Impl::~Impl ( )

inlineoverride

Definition at line 140 of file AsyncPluginValidator.cpp.

   {
      //important to reset delegate before IPCChannelStatusCallback::OnDisconnect
      //is called by server
      mDelegate = nullptr;
      mServer.reset();
   }

Member Function Documentation

HandleInternalError()

void AsyncPluginValidator::Impl::HandleInternalError ( const wxString &  msg )

inlineprivatenoexcept

Definition at line 66 of file AsyncPluginValidator.cpp.

   {
      try
      {
         BasicUI::CallAfter([wptr = weak_from_this(), msg]
         {
            if(auto self = wptr.lock(); self && self->mDelegate != nullptr)
               self->mDelegate->OnInternalError(msg);
         });
      }
      catch(...)
      {
         //no way to report about a problem, though shouldn't be the case...
      }
   }

References BasicUI::CallAfter().

Here is the call graph for this function:

HandleResult()

void AsyncPluginValidator::Impl::HandleResult ( detail::PluginValidationResult &&  result )

inlineprivatenoexcept

no way to report about a problem, though shouldn't be the case...

Definition at line 82 of file AsyncPluginValidator.cpp.

   {
      try
      {
         BasicUI::CallAfter([wptr = weak_from_this(), result = detail::PluginValidationResult { result }]
         {
            if(auto self = wptr.lock())
            {
               if(self->mDelegate == nullptr)
                  return;
 
               //Release the current value to keep state invariant
               //Caller is free to use Validate now
               std::optional<wxString> request;
               {
                  std::lock_guard lck_sync(self->mSync);
                  self->mRequest.swap(request);
               }
 
               if(!request.has_value())
               {
                  //Invalid state error
                  self->mDelegate->OnInternalError(result.GetErrorMessage());
                  return;
               }
 
               if(result.IsValid())
               {
                  for(auto& desc : result.GetDescriptors())
                     self->mDelegate->OnPluginFound(PluginDescriptor { desc });
               }
               else
               {
                  wxString providerId;
                  wxString pluginPath;
                  detail::ParseRequestString(*request, providerId, pluginPath);
 
                  self->mDelegate->OnPluginValidationFailed(providerId, pluginPath);
               }
               self->mDelegate->OnValidationFinished();
            }
         });
      }
      catch(...)
      {
      }
   }

References BasicUI::CallAfter(), and detail::ParseRequestString().

Here is the call graph for this function:

InactiveSince()

std::chrono::system_clock::time_point AsyncPluginValidator::Impl::InactiveSince ( ) const

inlinenoexcept

Definition at line 153 of file AsyncPluginValidator.cpp.

   {
      using std::chrono::system_clock;
 
      return system_clock::time_point { system_clock::duration{mLastTimeActive.load()} };
   }

OnConnect()

void AsyncPluginValidator::Impl::OnConnect ( IPCChannel &  channel )

inlineoverridevirtualnoexcept

Called when connection established.

Parameters

channel

Using this channel client or server can send data to the other side.

Implements IPCChannelStatusCallback.

Definition at line 160 of file AsyncPluginValidator.cpp.

   {
      std::lock_guard lck(mSync);
 
      mChannel = &channel;
      if(mRequest)
      {
         try
         {
            detail::PutMessage(channel, *mRequest);
         }
         catch(...)
         {
            HandleInternalError("Can't send message to host");
         }
      }
   }

References detail::PutMessage().

Here is the call graph for this function:

OnConnectionError()

void AsyncPluginValidator::Impl::OnConnectionError ( )

inlineoverridevirtualnoexcept

Called when connection attempt fails.

Implements IPCChannelStatusCallback.

Definition at line 189 of file AsyncPluginValidator.cpp.

   {
      HandleInternalError("Can't connect");
   }

OnDataAvailable()

void AsyncPluginValidator::Impl::OnDataAvailable ( const void *  data, size_t  size  )

inlineoverridevirtualnoexcept

Called when data chunk received as a result of a preceding call to IPCChannel::Send. Generally, data pointer should not be accessed outside this method, copied if necessary.

Parameters

data	Pointer to the chunk
size	Size of the chunk

Implements IPCChannelStatusCallback.

Definition at line 194 of file AsyncPluginValidator.cpp.

   {
      try
      {
         mMessageReader.ConsumeBytes(data, size);
         mLastTimeActive = std::chrono::system_clock::now().time_since_epoch().count();
         while(mMessageReader.CanPop())
         {
            auto message = mMessageReader.Pop();
            if(message.IsEmpty())
               continue;
 
            detail::PluginValidationResult result;
            XMLFileReader xmlReader;
            xmlReader.ParseString(&result, message);
 
            HandleResult(std::move(result));
         }
      }
      catch(...)
      {
         HandleInternalError("Can't process response from the host");
      }
   }

References XMLFileReader::ParseString(), and size.

Here is the call graph for this function:

OnDisconnect()

void AsyncPluginValidator::Impl::OnDisconnect ( )

inlineoverridevirtualnoexcept

Invalidates IPCChannel passed as argument in OnConnect.

Implements IPCChannelStatusCallback.

Definition at line 178 of file AsyncPluginValidator.cpp.

   {
      {
         std::lock_guard lck(mSync);
         mChannel = nullptr;
      }
      detail::PluginValidationResult result;
      result.SetError("Disconnect");
      HandleResult(std::move(result));
   }

References detail::PluginValidationResult::SetError().

Here is the call graph for this function:

operator=() [1/2]

Impl & AsyncPluginValidator::Impl::operator= ( Impl &&  )

delete

operator=() [2/2]

Impl & AsyncPluginValidator::Impl::operator= ( Impl &  )

delete

SetDelegate()

void AsyncPluginValidator::Impl::SetDelegate ( Delegate *  delegate )

inline

Definition at line 148 of file AsyncPluginValidator.cpp.

   {
      mDelegate = delegate;
   }

StartHost()

void AsyncPluginValidator::Impl::StartHost ( )

inlineprivate

Definition at line 57 of file AsyncPluginValidator.cpp.

   {
      auto server = std::make_unique<IPCServer>(*this);
      if(!PluginHost::Start(server->GetConnectPort()))
         throw std::runtime_error("cannot start plugin host process");
      mLastTimeActive = std::chrono::system_clock::now().time_since_epoch().count();
      mServer = std::move(server);
   }

References mLastTimeActive, mServer, and PluginHost::Start().

Here is the call graph for this function:

Validate()

void AsyncPluginValidator::Impl::Validate ( const wxString &  providerId, const wxString &  pluginPath  )

inline

Definition at line 219 of file AsyncPluginValidator.cpp.

   {
      std::lock_guard lck(mSync);
 
      //one request at a time
      assert(!mRequest.has_value());
 
      mRequest = detail::MakeRequestString(providerId, pluginPath);
      if(mChannel)
         detail::PutMessage(*mChannel, *mRequest);
      else
         //create host process on demand
         StartHost();
   }

References detail::MakeRequestString(), and detail::PutMessage().

Here is the call graph for this function:

Member Data Documentation

mChannel

IPCChannel* AsyncPluginValidator::Impl::mChannel {nullptr}

private

Definition at line 37 of file AsyncPluginValidator.cpp.

mDelegate

Delegate* AsyncPluginValidator::Impl::mDelegate {nullptr}

private

Definition at line 49 of file AsyncPluginValidator.cpp.

mLastTimeActive

std::atomic<std::chrono::system_clock::duration::rep> AsyncPluginValidator::Impl::mLastTimeActive

private

Definition at line 39 of file AsyncPluginValidator.cpp.

Referenced by StartHost().

mMessageReader

detail::InputMessageReader AsyncPluginValidator::Impl::mMessageReader

private

Definition at line 54 of file AsyncPluginValidator.cpp.

mRequest

std::optional<wxString> AsyncPluginValidator::Impl::mRequest

private

Definition at line 38 of file AsyncPluginValidator.cpp.

mServer

std::unique_ptr<IPCServer> AsyncPluginValidator::Impl::mServer

private

Definition at line 50 of file AsyncPluginValidator.cpp.

Referenced by StartHost().

mSync

spinlock AsyncPluginValidator::Impl::mSync

private

Definition at line 45 of file AsyncPluginValidator.cpp.

---

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

• AsyncPluginValidator.cpp