From e5cfe215abefdfd41ae4ababa985d11a030a1fb4 Mon Sep 17 00:00:00 2001 From: acarioni Date: Fri, 10 Feb 2023 12:13:26 +0100 Subject: [PATCH] update docs --- CHANGELOG.md | 9 +++++++++ README.md | 18 +++++++++--------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dcd0ef0..6e45be9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # SDK for Swift Clients CHANGELOG +## 5.0.2 + +_Compatible with Lightstreamer Server since 7.3.2._
+_Compatible with code developed for the previous versions._
+_Released on 10 Feb 2023._ + +Fixed a race condition that in some cases, when two or more LightstreamerClient instances were running concurrently, could have caused a deadlock among the clients. + + ## 5.0.1 _Compatible with Lightstreamer Server since 7.3.0._
diff --git a/README.md b/README.md index 43cbc6f..b7c950f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Once you have your Swift package set up, adding Lightstreamer Swift Client SDK a ```swift dependencies: [ - .package(url: "https://github.com/Lightstreamer/Lightstreamer-lib-client-swift.git", from: "5.0.1") + .package(url: "https://github.com/Lightstreamer/Lightstreamer-lib-client-swift.git", from: "5.0.2") ] ``` @@ -71,7 +71,7 @@ If you prefer not to use any of the aforementioned dependency managers, you can ## Quickstart -To connect to a Lightstreamer Server, a [LightstreamerClient](https://lightstreamer.com/api/ls-swift-client/5.0.1/Classes/LightstreamerClient.html) object has to be created, configured, and instructed to connect to the Lightstreamer Server. +To connect to a Lightstreamer Server, a [LightstreamerClient](https://lightstreamer.com/api/ls-swift-client/5.0.2/Classes/LightstreamerClient.html) object has to be created, configured, and instructed to connect to the Lightstreamer Server. A minimal version of the code that creates a LightstreamerClient and connects to the Lightstreamer Server on *https://push.lightstreamer.com* will look like this: ```swift @@ -79,7 +79,7 @@ let client = LightstreamerClient(serverAddress: "https://push.lightstreamer.com/ client.connect() ``` -For each subscription to be subscribed to a Lightstreamer Server a [Subscription](https://lightstreamer.com/api/ls-swift-client/5.0.1/Classes/Subscription.html) instance is needed. +For each subscription to be subscribed to a Lightstreamer Server a [Subscription](https://lightstreamer.com/api/ls-swift-client/5.0.2/Classes/Subscription.html) instance is needed. A simple Subscription containing three items and two fields to be subscribed in *MERGE* mode is easily created (see [Lightstreamer General Concepts](https://www.lightstreamer.com/docs/ls-server/latest/General%20Concepts.pdf)): ```swift @@ -91,7 +91,7 @@ sub.requestedSnapshot = .yes client.subscribe(sub) ``` -Before sending the subscription to the server, usually at least one [SubscriptionDelegate](https://lightstreamer.com/api/ls-swift-client/5.0.1/Protocols/SubscriptionDelegate.html) is attached to the Subscription instance in order to consume the real-time updates. The following code shows the values of the fields *stock_name* and *last_price* each time a new update is received for the subscription: +Before sending the subscription to the server, usually at least one [SubscriptionDelegate](https://lightstreamer.com/api/ls-swift-client/5.0.2/Protocols/SubscriptionDelegate.html) is attached to the Subscription instance in order to consume the real-time updates. The following code shows the values of the fields *stock_name* and *last_price* each time a new update is received for the subscription: ```swift class SubscriptionDelegateImpl: SubscriptionDelegate { @@ -112,7 +112,7 @@ Before you can use MPN services, you need to - register your app with APNs (read carefully the documentation about [Setting Up a Remote Notification Server](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server)); - configure the Lightstreamer MPN module (read carefully the section *5 Mobile and Web Push Notifications* in the [General Concepts guide](https://lightstreamer.com/docs/ls-server/7.3.0/General%20Concepts.pdf)). -After you have an APNs account, you can create a [MPN device](https://lightstreamer.com/api/ls-swift-client/5.0.1/Classes/MPNDevice.html), which represents a specific app running on a specific mobile device. +After you have an APNs account, you can create a [MPN device](https://lightstreamer.com/api/ls-swift-client/5.0.2/Classes/MPNDevice.html), which represents a specific app running on a specific mobile device. The following snippet shows a sample implementation of the iOS app delegate methods needed to register for remote notifications and receive the corresponding token. @@ -135,7 +135,7 @@ func application(_ application: UIApplication, } ``` -To receive notifications, you need to subscribe to a [MPN subscription](https://lightstreamer.com/api/ls-swift-client/5.0.1/Classes/MPNSubscription.html): it contains subscription details and the listener needed to monitor its status. Real-time data is routed via native push notifications. +To receive notifications, you need to subscribe to a [MPN subscription](https://lightstreamer.com/api/ls-swift-client/5.0.2/Classes/MPNSubscription.html): it contains subscription details and the listener needed to monitor its status. Real-time data is routed via native push notifications. ```swift let builder = MPNBuilder() @@ -161,7 +161,7 @@ The optional trigger expression lets you specify when to send the notificati ## Logging -To enable the internal client logger, create an instance of [LoggerProvider](https://lightstreamer.com/api/ls-swift-client/5.0.1/Protocols/LSLoggerProvider.html) and set it as the default provider of [LightstreamerClient](https://lightstreamer.com/api/ls-swift-client/5.0.1/Classes/LightstreamerClient.html). +To enable the internal client logger, create an instance of [LoggerProvider](https://lightstreamer.com/api/ls-swift-client/5.0.2/Protocols/LSLoggerProvider.html) and set it as the default provider of [LightstreamerClient](https://lightstreamer.com/api/ls-swift-client/5.0.2/Classes/LightstreamerClient.html). ```swift let loggerProvider = ConsoleLoggerProvider(level: .debug) @@ -169,13 +169,13 @@ LightstreamerClient.setLoggerProvider(loggerProvider) ``` ## Compatibility -Compatible with Lightstreamer Server since version 7.3.0. +Compatible with Lightstreamer Server since version 7.3.2. ## Documentation - [Live demos](https://demos.lightstreamer.com/?p=lightstreamer&t=client&lclient=apple&sclientapple=ios&sclientapple=macos&sclientapple=tvos&sclientapple=watchos) -- [API Reference](https://lightstreamer.com/api/ls-swift-client/5.0.1/index.html) +- [API Reference](https://lightstreamer.com/api/ls-swift-client/5.0.2/index.html) - [Lightstreamer General Concepts](https://lightstreamer.com/docs/ls-server/7.3.0/General%20Concepts.pdf)