SwiftSignalRClient

A Swift SignalR Client for the Asp.Net Core version of SignalR

Before filing an issue please check Frequently Asked Questions

Installation

Cocoapods

Add the following lines to your Podfile:

use_frameworks!
pod 'SwiftSignalRClient'

Then run:

pod install

Swift Package Manager

Add the following to your Package dependencies:

.package(url: "https://github.com/moozzyk/SignalR-Client-Swift", .upToNextMinor(from: "0.6.0")),

Then include "SignalRClient" in your target dependencies. For example:

.target(name: "MySwiftPackage", dependencies: ["SignalRClient"]),

Carthage

Add the following lines to your Cartfile:

github "moozzyk/SignalR-Client-Swift"

Then run:

carthage update

Usage

Add import SwiftSignalRClient (or import SignalRClient if you are using Swift Package Manager) to swift files you would like to use the client in.

A typical implementation looks like the following:

import Foundation
import SwiftSignalRClient

public class SignalRService {
    private var connection: HubConnection
    
    public init(url: URL) {
        connection = HubConnectionBuilder(url: url).withLogging(minLogLevel: .error).build()
        connection.on(method: "MessageReceived", callback: { (user: String, message: String) in
            do {
                self.handleMessage(message, from: user)
            } catch {
                print(error)
            }
        })
        
        connection.start()
    }
    
    private func handleMessage(_ message: String, from user: String) {
        // Do something with the message.
    }
}

More detailed user's guide:

• Swift Client for the ASP.Net Core Version of SignalR – Part 1: Getting Started
• Swift Client for the ASP.Net Core Version of SignalR – Part 1: Beyond the Basics
• Automatic Reconnection in the Swift SignalR Client

Examples

There are several sample projects in the Examples folder. They include:

• SignalRClient.xcodeproj

  An Xcode workspace that has compiled libraries for macOS (OSX) and iOS, along with the Application targets 'ConnectionSample', 'HubSample', and 'HubSamplePhone'.

• TestServer

  A .Net solution that the unit tests and samples can be run against.

  The TestServer Requires .NET Core SDK 3.0.100 or later.

  To run, navigate to the TestServer folder and execute the following in the terminal:

  % npm install
  % dotnet run
  

  When running the TestServer project on macOS Monterey (12.0 or greater), you may encounter the error: "Failed to bind to address http://0.0.0.0:5000: address already in use.". This is due to Apple now advertising an 'AirPlay Receiver' on that port. This port can be freed by disabling the receiver: Navigate to System Preferences > Sharing and uncheck AirPlay Receiver.

Disclaimer

I am providing code in the repository to you under an open source license. Because this is my personal repository, the license you receive to my code is from me and not my employer (Facebook)

Hits