パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v2.0.3

flutter_client_sse

SSE API を使用するのを支援する Dart パッケージ。イベント、ID、データの解析されたモデルを返すことによってサーバー送信イベントを処理します。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
4.5万
いいね数
110
Pub ポイント
150

パッケージをインストール

flutter pub add flutter_client_sse

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Flutterアプリケーションでのサーバー送信イベント(SSE)APIの利用を簡素化するためのDartパッケージです。このパッケージは、サーバーからイベントデータをストリームし、各イベントをイベントタイプ、ID、ペイロードなどの構造化されたコンポーネントに解析します。ライブ通知、株価、チャットメッセージなどのリアルタイム更新に最適で、Android、iOS、Web、macOS、Windows、Linuxなどすべての主要プラットフォームをサポートしています。低レベルのHTTP処理を抽象化し、開発者が受信したイベントに反応できるクリーンなインターフェースを提供します。

用途

  • リアルタイム通知
  • ライブデータストリーミング
  • チャットアプリケーション
  • 株価の更新
  • ステータスモニタリング
  • イベント駆動型UI

主な機能

  • イベントID、タイプ、データを解析する
  • クロスプラットフォームのデプロイをサポート
  • ストリームベースのイベント処理
  • シンプルなAPI統合
  • 自動再接続の試行
  • モデルベースの応答解析

適している対象

  • リアルタイムアプリ開発
  • バックエンドからフロントエンドへのイベント通信
  • ライブ更新を必要とするアプリ
  • SSE API を使用する開発者
  • ライブデータを備えたクロスプラットフォームプロジェクト

注意事項

  • サーバーサイドのSSEサポートが必要です
  • 1方向のサーバーからクライアントへの通信に限定
  • カスタムエラーハンドリングが必要になる場合があります
  • 双方向通信には適していません
  • 安定したネットワーク接続に依存します

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Flutter Client SSE

Dart package to help consume Server Sent Events

Features:
  • Consumes server sent events
  • Returns parsed model of the event, id and the data

Getting Started

Import

Add the following import in the pubspec.yaml file

client_sse:
    git:
      url: https://github.com/pratikbaid3/flutter_client_sse
      path:
Example
///GET REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.GET,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    }).listen((event) {
        print('Id: ' + event.id!);
        print('Event: ' + event.event!);
        print('Data: ' + event.data!);
    },
);

///POST REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.POST,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    },
    body: {
        "name": "Hello",
        "customerInfo": {"age": 25, "height": 168}
    }).listen((event) {
            print('Id: ' + event.id!);
            print('Event: ' + event.event!);
            print('Data: ' + event.data!);
    },
);

Running Sample Backend

Nest The backend is in NestJS serving a single SSE api.

Installation

$ yarn install

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

カテゴリー

依存関係

依存関係一覧 1 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。