flutter::FlutterDesktopMessenger Class Reference

#include <flutter_desktop_messenger.h>

Public Member Functions
	FlutterDesktopMessenger ()=default
FlutterDesktopMessengerRef	ToRef ()
	Convert to FlutterDesktopMessengerRef. More...
flutter::FlutterWindowsEngine *	GetEngine () const
	Getter for the engine field. More...
void	SetEngine (flutter::FlutterWindowsEngine *arg_engine)
FlutterDesktopMessenger *	AddRef ()
void	Release ()
std::mutex &	GetMutex ()

Static Public Member Functions
static FlutterDesktopMessenger *	FromRef (FlutterDesktopMessengerRef ref)
	Convert from FlutterDesktopMessengerRef. More...

Detailed Description

A messenger object used to invoke platform messages.

On Windows, the message handler is essentially the |FlutterWindowsEngine|, this allows a handle to the |FlutterWindowsEngine| that will become invalidated if the |FlutterWindowsEngine| is destroyed.

Definition at line 23 of file flutter_desktop_messenger.h.

Constructor & Destructor Documentation

FlutterDesktopMessenger()

flutter::FlutterDesktopMessenger::FlutterDesktopMessenger ( )

default

Member Function Documentation

AddRef()

FlutterDesktopMessenger* flutter::FlutterDesktopMessenger::AddRef ( )

inline

Increments the reference count.

Thread-safe.

Definition at line 50 of file flutter_desktop_messenger.h.

                                    {
    ref_count_.fetch_add(1);
    return this;
  }

Referenced by FlutterDesktopMessengerAddRef().

FromRef()

static FlutterDesktopMessenger* flutter::FlutterDesktopMessenger::FromRef ( FlutterDesktopMessengerRef  ref )

inlinestatic

Convert from FlutterDesktopMessengerRef.

Definition at line 33 of file flutter_desktop_messenger.h.

                                                                          {
    return reinterpret_cast<FlutterDesktopMessenger*>(ref);
  }

Referenced by FlutterDesktopMessengerAddRef(), FlutterDesktopMessengerIsAvailable(), FlutterDesktopMessengerLock(), FlutterDesktopMessengerRelease(), FlutterDesktopMessengerSendResponse(), FlutterDesktopMessengerSendWithReply(), FlutterDesktopMessengerSetCallback(), and FlutterDesktopMessengerUnlock().

GetEngine()

flutter::FlutterWindowsEngine* flutter::FlutterDesktopMessenger::GetEngine ( ) const

inline

Getter for the engine field.

Definition at line 38 of file flutter_desktop_messenger.h.

{ return engine; }

Referenced by FlutterDesktopMessengerIsAvailable(), FlutterDesktopMessengerSendResponse(), FlutterDesktopMessengerSendWithReply(), and FlutterDesktopMessengerSetCallback().

GetMutex()

std::mutex& flutter::FlutterDesktopMessenger::GetMutex ( )

inline

Returns the mutex associated with the |FlutterDesktopMessenger|.

This mutex is used to synchronize reading or writing state inside the |FlutterDesktopMessenger| (ie |engine|).

Definition at line 70 of file flutter_desktop_messenger.h.

{ return mutex_; }

Referenced by FlutterDesktopMessengerLock(), and FlutterDesktopMessengerUnlock().

Release()

void flutter::FlutterDesktopMessenger::Release ( )

inline

Decrements the reference count and deletes the object if the count has gone to zero.

Thread-safe.

Definition at line 59 of file flutter_desktop_messenger.h.

                 {
    int32_t old_count = ref_count_.fetch_sub(1);
    if (old_count <= 1) {
      delete this;
    }
  }

Referenced by FlutterDesktopMessengerRelease().

SetEngine()

void flutter::FlutterDesktopMessenger::SetEngine ( flutter::FlutterWindowsEngine *  arg_engine )

inline

Setter for the engine field. Thread-safe.

Definition at line 42 of file flutter_desktop_messenger.h.

                                                          {
    std::scoped_lock lock(mutex_);
    engine = arg_engine;
  }

ToRef()

FlutterDesktopMessengerRef flutter::FlutterDesktopMessenger::ToRef ( )

inline

Convert to FlutterDesktopMessengerRef.

Definition at line 28 of file flutter_desktop_messenger.h.

                                     {
    return reinterpret_cast<FlutterDesktopMessengerRef>(this);
  }

Referenced by FlutterDesktopMessengerAddRef().

---

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

• shell/platform/windows/flutter_desktop_messenger.h