flutter::PlatformMessageHandlerAndroid Class Reference

#include <platform_message_handler_android.h>

Inheritance diagram for flutter::PlatformMessageHandlerAndroid:

Public Member Functions
	PlatformMessageHandlerAndroid (const std::shared_ptr< PlatformViewAndroidJNI > &jni_facade)
void	HandlePlatformMessage (std::unique_ptr< PlatformMessage > message) override
bool	DoesHandlePlatformMessageOnPlatformThread () const override
void	InvokePlatformMessageResponseCallback (int response_id, std::unique_ptr< fml::Mapping > mapping) override
void	InvokePlatformMessageEmptyResponseCallback (int response_id) override
Public Member Functions inherited from flutter::PlatformMessageHandler
virtual	~PlatformMessageHandler ()=default
virtual void	HandlePlatformMessage (std::unique_ptr< PlatformMessage > message)=0
virtual bool	DoesHandlePlatformMessageOnPlatformThread () const =0
virtual void	InvokePlatformMessageResponseCallback (int response_id, std::unique_ptr< fml::Mapping > mapping)=0
virtual void	InvokePlatformMessageEmptyResponseCallback (int response_id)=0

Detailed Description

Definition at line 18 of file platform_message_handler_android.h.

Constructor & Destructor Documentation

PlatformMessageHandlerAndroid()

flutter::PlatformMessageHandlerAndroid::PlatformMessageHandlerAndroid ( const std::shared_ptr< PlatformViewAndroidJNI > &  jni_facade )

explicit

Definition at line 9 of file platform_message_handler_android.cc.

    : jni_facade_(jni_facade) {}

Member Function Documentation

DoesHandlePlatformMessageOnPlatformThread()

bool flutter::PlatformMessageHandlerAndroid::DoesHandlePlatformMessageOnPlatformThread ( ) const

inlineoverridevirtual

Returns true if the platform message will ALWAYS be dispatched to the platform thread.

Platforms that support Background Platform Channels will return false.

Implements flutter::PlatformMessageHandler.

Definition at line 23 of file platform_message_handler_android.h.

                                                                  {
    return false;
  }

HandlePlatformMessage()

void flutter::PlatformMessageHandlerAndroid::HandlePlatformMessage ( std::unique_ptr< PlatformMessage >  message )

overridevirtual

Ultimately sends the PlatformMessage to the host platform. This method is invoked on the ui thread.

Implements flutter::PlatformMessageHandler.

Definition at line 56 of file platform_message_handler_android.cc.

                                                   {
  // Called from any thread.
  int response_id = next_response_id_.fetch_add(1);
  if (auto response = message->response()) {
    std::lock_guard lock(pending_responses_mutex_);
    pending_responses_[response_id] = response;
  }
  // This call can re-enter in InvokePlatformMessageXxxResponseCallback.
  jni_facade_->FlutterViewHandlePlatformMessage(std::move(message),
                                                response_id);
}

InvokePlatformMessageEmptyResponseCallback()

void flutter::PlatformMessageHandlerAndroid::InvokePlatformMessageEmptyResponseCallback ( int  response_id )

overridevirtual

Performs the return procedure for an associated call to HandlePlatformMessage where there is no return value. This method should be thread-safe and able to be invoked on any thread.

Implements flutter::PlatformMessageHandler.

Definition at line 36 of file platform_message_handler_android.cc.

                     {
  // Called from any thread.
  if (!response_id) {
    return;
  }
  fml::RefPtr<flutter::PlatformMessageResponse> message_response;
  {
    std::lock_guard lock(pending_responses_mutex_);
    auto it = pending_responses_.find(response_id);
    if (it == pending_responses_.end()) {
      return;
    }
    message_response = std::move(it->second);
    pending_responses_.erase(it);
  }
  message_response->CompleteEmpty();
}

InvokePlatformMessageResponseCallback()

void flutter::PlatformMessageHandlerAndroid::InvokePlatformMessageResponseCallback ( int  response_id, std::unique_ptr< fml::Mapping >  mapping  )

overridevirtual

Performs the return procedure for an associated call to HandlePlatformMessage. This method should be thread-safe and able to be invoked on any thread.

Implements flutter::PlatformMessageHandler.

Definition at line 13 of file platform_message_handler_android.cc.

                                       {
  // Called from any thread.
  if (!response_id) {
    return;
  }
  // TODO(gaaclarke): Move the jump to the ui thread here from
  // PlatformMessageResponseDart so we won't need to use a mutex anymore.
  fml::RefPtr<flutter::PlatformMessageResponse> message_response;
  {
    std::lock_guard lock(pending_responses_mutex_);
    auto it = pending_responses_.find(response_id);
    if (it == pending_responses_.end()) {
      return;
    }
    message_response = std::move(it->second);
    pending_responses_.erase(it);
  }
 
  message_response->Complete(std::move(mapping));
}

---

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

• shell/platform/android/platform_message_handler_android.h
• shell/platform/android/platform_message_handler_android.cc