# sankalppatra/sa-react-native-mqtt architecture

> Architecture diagram of the GitHub repository sankalppatra/sa-react-native-mqtt, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sankalppatra/sa-react-native-mqtt
- Repository: https://github.com/sankalppatra/sa-react-native-mqtt

## Overview

##### Project type and purpose
- This is a React Native “native module” library (sa-react-native-mqtt) plus an example React Native app (rnmqttexample) that demonstrates usage.
- Purpose: expose a native MQTT client (iOS via CocoaPods MQTTClient; Android via Java implementation) to React Native JS through the standard Bridge API.

##### File structure
- Top-level:
- android/ – native‐module implementation for Android (Java code under com.tuanpm.RCTMqtt)
- ios/ – native‐module implementation for iOS (Objective-C wrappers RCTMqtt.* + Podspec file)
- index.js & index.d.ts – JS entrypoint, declare and export createClient API
- rnmqttexample/ – standalone React Native example app demonstrating module usage
- package.json – declares dependency on this module, linking workflows
- Patterns:
- React Native Bridge → Native Module
- Example app structured as typical RN project (android/, ios/, App.js, Metro config)
- CocoaPods under example’s ios/Pods for MQTTClient library

##### Insights from README
- Exposes a promise-based JS API: createClient, on(event), connect/disconnect, publish/subscribe
- iOS: depends on CocoaPods “MQTTClient”
- Android: Gradle project under android/ folder
- External dependency: any MQTT broker (mqtt://… or mqtts://…)

## Diagram (Mermaid)

```mermaid
graph TB
    %% JS Layers
    subgraph "Example App (rnmqttexample)" 
        direction TB
        ExampleApp["App.js<br/>index.js<br/>realtimeManager.js"]:::js
    end

    subgraph "Core Module (sa-react-native-mqtt)" 
        direction TB
        CoreIndexJS["index.js"]:::js
        CoreIndexDTS["index.d.ts"]:::js
    end

    subgraph "React Native Bridge" 
        direction TB
        Bridge["NativeModules.RCTMqtt"]:::bridge
    end

    subgraph "Native Module" 
        direction TB

        subgraph "Android Implementation" 
            direction TB
            AndroidRCTMqtt["RCTMqtt.java"]:::native
            AndroidModule["RCTMqttModule.java"]:::native
            AndroidPackage["RCTMqttPackage.java"]:::native
            AndroidGradle["build.gradle"]:::native
            AndroidClient["Android MQTT Client"]:::native
        end

        subgraph "iOS Implementation" 
            direction TB
            IOSPodspec["sa-react-native-mqtt.podspec"]:::native
            IOSRCTMqttH["RCTMqtt.h"]:::native
            IOSRCTMqttM["RCTMqtt.m"]:::native
            IOSMqttH["Mqtt.h"]:::native
            IOSMqttM["Mqtt.m"]:::native
            IOSXcodeproj["project.pbxproj"]:::native
            IOSClient["MQTTClient CocoaPod"]:::native
        end
    end

    Broker["External MQTT Broker"]:::external

    %% Connections
    ExampleApp -->|"calls createClient()"| CoreIndexJS
    CoreIndexJS -->|"declares API"| CoreIndexDTS
    CoreIndexJS -->|"invokes NativeModules"| Bridge
    Bridge -->|"invoke Android"| AndroidModule
    Bridge -->|"invoke iOS"| IOSRCTMqttM
    AndroidModule -->|"uses package"| AndroidPackage
    AndroidModule -->|"instantiates"| AndroidClient
    IOSRCTMqttM -->|"wraps native client"| IOSClient
    AndroidClient -->|"MQTT traffic"| Broker
    IOSClient -->|"MQTT traffic"| Broker
    Broker -->|"publishes events"| AndroidClient
    Broker -->|"publishes events"| IOSClient
    AndroidClient -->|"native events"| AndroidModule
    IOSClient -->|"native events"| IOSRCTMqttM
    AndroidModule -->|"emit events"| Bridge
    IOSRCTMqttM -->|"emit events"| Bridge
    Bridge -->|"callbacks"| CoreIndexJS
    CoreIndexJS -->|"on(event)"| ExampleApp

    %% Click Events
    click CoreIndexJS "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/index.js"
    click CoreIndexDTS "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/index.d.ts"
    click IOSPodspec "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/sa-react-native-mqtt.podspec"
    click IOSRCTMqttH "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/RCTMqtt.h"
    click IOSRCTMqttM "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/RCTMqtt.m"
    click IOSMqttH "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/Mqtt.h"
    click IOSMqttM "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/Mqtt.m"
    click AndroidRCTMqtt "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/android/src/main/java/com/tuanpm/RCTMqtt/RCTMqtt.java"
    click AndroidModule "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/android/src/main/java/com/tuanpm/RCTMqtt/RCTMqttModule.java"
    click AndroidPackage "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/android/src/main/java/com/tuanpm/RCTMqtt/RCTMqttPackage.java"
    click AndroidGradle "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/android/build.gradle"
    click IOSXcodeproj "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/ios/RCTMqtt.xcodeproj/project.pbxproj"
    click AndroidClient "https://github.com/sankalppatra/sa-react-native-mqtt/tree/main/android/src/main/java/com/tuanpm/RCTMqtt"
    click IOSClient "https://github.com/sankalppatra/sa-react-native-mqtt/tree/main/rnmqttexample/ios/Pods/MQTTClient"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/App.js"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/index.js"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/realtimeManager.js"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/metro.config.js"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/package.json"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/tree/main/rnmqttexample/ios/Podfile"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/ios/rnmqttexample/AppDelegate.m"
    click ExampleApp "https://github.com/sankalppatra/sa-react-native-mqtt/blob/main/rnmqttexample/ios/rnmqttexample/AppDelegate.h"

    %% Styles
    classDef js fill:#add8e6,stroke:#333,stroke-width:1px
    classDef bridge fill:#ffa500,stroke:#333,stroke-width:1px
    classDef native fill:#90ee90,stroke:#333,stroke-width:1px
    classDef external fill:#d3d3d3,stroke:#333,stroke-width:1px
```
