Flutter messaging classes and their native platform peers

Communication between Flutter modules and Mobile Native code happens over platform channels.  The docs are all over the place so I created this cheat sheet for the different channel types and their class documentation.

YouTube walkthrough video

Mobile Native Communication


Communication between the Mobile native code and Flutter happens over platform channels. Web communication happens via window messaging.


Flutter Channel types


There are three native platform channel types. V1 of this application uses the Message Channel


Channel type and Flutter classDescriptionFlutter
Native		Native
Flutter		Supports
Return
MethodInvoke method on the other sideYesYesVia result
MessageSends a message to a remote listenerYesYesVia reply
EventStreams and sinks. Events can flow in both directionsYesYesN/A

Channel Implementation Classes


Dart/Flutter, Android, and iOS have corresponding `channel` classes for each channel type. The three platform channel implementation classes in Flutter, iOS and, Android are:


Flutter ClassiOS ClassAndroid Class
MethodChannelFlutterMethodChanelMethodChannel
EventChannelFlutterEventChannelEventChannel
BasicMessageChannelFlutterBasicMessageChannelBasicMessageChannel

Method Channel Codecs MethodCodec


Method channels a method on the opposite side.  Method channels use MethodCode implementations.


Flutter Codec ClassiOS Codec ClassAndroid Codec Class
MethodCodec Interface......
StandardMethodCodecFlutterStandardMethodCodecStandardMethodCodec
JSONMethodCodecFlutterJSONMethodCodecJSONMethodCodec

Message Channel Codecs


Message channels use MessageCodec Implementations.  Messages are a single payload with an optional return value. Uses codecs shown below.


Flutter Codec ClassiOS Codec ClassAndroid Codec Class
MessageCodec Interface......
StandardMessageCodecFlutterStandardMessageCodecStandardMessageCodec
BinaryCodecFlutterBinaryMessageCodecBinaryCodec
JsonMessageCodecFlutterJSONMessageCodecJSONMessageCodec
StringCodecFlutterStringCodecStringCodec

Event Channel


Event channels are continuous broadcast streams that use a MethodCodec. Some future blog will describe Event Channels.


Flutter Codec ClassiOS Codec ClassAndroid Codec Class
See MethodCodecSee MethodCodecSee MethodCodec

Platform-specific implementations

Additional details are available for each platform implementation in the sample code in the referenced repository. From README.md in GitHub repository

Platform
Web application with message communication between Flutter and Web
Android application with message communication between Flutter and Android
iOS application with message communication between Flutter and Android

YouTube Video

Revision History

Created 2024 07 - copied from the readme and manually reformatted

Comments

Post a Comment

Popular posts from this blog

Installing the RNDIS driver on Windows 11 to use USB Raspberry Pi as network attached

Image
I do a lot of my development and configuration via ssh into my Raspberry Pi Zero over the RNDIS connection. Some models of the Raspberry PIs can be configured with  gadget drivers  that let the Raspberry pi emulate different devices when plugged into computers via USB. My favorite gadget  is the network profile that makes a Raspberry Pi look like an RNDIS-attached network device.  All types of network services travel over an RNDIS device without knowing it is a USB hardware connection. A Raspberry Pi shows up as a Remote NDIS (RNDIS) device when you plug the Pi into a PC or Mac via a USB cable. The gadget  in the Windows Device Manager picture shows this RNDIS Gadget connectivity between a Windows machine and a Raspberry Pi. The Problem Windows 11 and Windows 10 no longer auto-installs the RNDIS driver that makes magic happen. Windows recognizes that the Raspberry Pi is some type of generic USB COM device. Manually running W indows Update  or  Upd...
Read more

Understanding your WSL2 RAM and swap - Changing the default 50%-25%

Image
The Windows Subsystem for Linux operates as a virtual machine that can dynamically grow the amount of RAM to a maximum set at startup time.  Microsoft sets a default maximum RAM available to 50% of the physical memory and a swap-space that is 1/4 of the maximum WSL RAM.  You can scale those numbers up or down to allocate more or less RAM to the Linux instance. The first drawing shows the default WSL memory and swap space sizing. The images below show a developer machine that is running a dev environment in WSL2 and Docker Desktop.  Docker Desktop has two of its own WSL modules that need to be accounted for.  You can see that the memory would actually be oversubscribed, 3 x 50% if every VM used its maximum memory.  The actual amount of memory used is significantly smaller allowing every piece to fit. Click to Enlarge The second drawing shows the memory allocation on my 64GB laptop. WSL Linux defaul...
Read more

Almost PaaS Document Parsing with Tika and AWS Elastic Beanstalk

Image
The Apache Tika project provides a  library capable of parsing and extracting data and meta data from over 1000 file types.  Tika is available as a single jar file that can be included inside applications or as a deployable jar file that runs Tika as a standalone service. This blog describes deploying the Tika jar as an auto-scale service in Amazon AWS Elastic Beanstalk.  I selected Elastic Beanstalk because it supports jar based deployments without any real Infrastructure configuration. Elastic Beanstalk auto-scale should take care of scaling up and down for for the number of requests you get. Tika parses documents and extracts their text completely in memory. Tika was deployed for this blog using EC2 t2.micro instances available in the AWS free tier. t2.micro VMs are 1GB which means that you are restricted in document complexity and size. You would size your instances appropriately for your largest documents.   Preconditions An AWS account. AWS ac...
Read more