SignalR-ObjC 技术文档

1. 安装指南

使用 CocoaPods 安装

CocoaPods 是一个 Objective-C 的依赖管理工具，可以自动化并简化在项目中使用第三方库（如 SignalR-ObjC）的过程。首先，你需要安装 CocoaPods：

$ gem install cocoapods

然后在你的 Podfile 中指定 SignalR-ObjC：

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

pod 'SignalR-ObjC', '~> 2.0'

最后，运行以下命令来安装依赖：

$ pod install

2. 项目使用说明

概述

SignalR-ObjC 是一个用于 iOS 和 Mac OS X 的客户端库，基于 AFNetworking 和 SocketRocket 两个开源库构建。它旨在与 ASP.NET SignalR 一起使用，ASP.NET SignalR 是一个为 ASP.NET 开发者提供的库，可以非常简单地为应用程序添加实时功能。

核心组件

• SRHubConnection: 用于与 SignalR Hub 进行通信。
• SRConnection: 用于与 SignalR 持久连接进行通信。
• SRAutoTransport: 自动选择最佳的传输方式。
• SRWebSocketTransport: 使用 WebSocket 进行通信。
• SRServerSentEventsTransport: 使用服务器发送事件进行通信。
• SRLongPollingTransport: 使用长轮询进行通信。

3. 项目 API 使用文档

持久连接

服务器端代码

using System.Threading.Tasks;
using Microsoft.AspNet.SignalR;

public class MyConnection : PersistentConnection 
{
    protected override Task OnReceived(IRequest request, string connectionId, string data) 
    {
        // 广播数据到所有客户端
        return Connection.Broadcast(data);
    }
}

客户端代码

#import "SignalR.h"

SRConnection *connection = [SRConnection connectionWithURLString:@"http://localhost/mysite/echo"];

// 注册连接生命周期事件
[connection setStarted:^{
    NSLog(@"Connection Started");
    [connection send:@"hello world"];
}];
[connection setReceived:^(NSString *message) {
    NSLog(@"Connection Recieved Data: %@",message);
}];
[connection setConnectionSlow:^{
    NSLog(@"Connection Slow");
}];
[connection setReconnecting:^{
    NSLog(@"Connection Reconnecting");
}];
[connection setReconnected:^{
    NSLog(@"Connection Reconnected");
}];
[connection setClosed:^{
    NSLog(@"Connection Closed");
}];
[connection setError:^(NSError *error) {
    NSLog(@"Connection Error %@",error);
}];

[connection start];

Hubs

服务器端代码

public class Chat : Hub 
{
    public void Send(string message)
    {
        // 调用所有客户端的 addMessage 方法
        Clients.All.addMessage(message);
    }
}

客户端代码

#import "SignalR.h"

SRHubConnection *hubConnection = [SRHubConnection connectionWithURLString:@"http://localhost/mysite"];
SRHubProxy *chat = [hubConnection createHubProxy:@"chat"];
[chat on:@"addMessage" perform:self selector:@selector(addMessage:)];

// 注册连接生命周期事件
[hubConnection setStarted:^{
    NSLog(@"Connection Started");
    [connection send:@"hello world"];
}];
[hubConnection setReceived:^(NSString *message) {
    NSLog(@"Connection Recieved Data: %@",message);
}];
[hubConnection setConnectionSlow:^{
    NSLog(@"Connection Slow");
}];
[hubConnection setReconnecting:^{
    NSLog(@"Connection Reconnecting");
}];
[hubConnection setReconnected:^{
    NSLog(@"Connection Reconnected");
}];
[hubConnection setClosed:^{
    NSLog(@"Connection Closed");
}];
[hubConnection setError:^(NSError *error) {
    NSLog(@"Connection Error %@",error);
}];

[hubConnection start];

- (void)addMessage:(NSString *)message {
    // 打印接收到的消息
    NSLog(message);
}

4. 项目安装方式

SignalR-ObjC 可以通过 CocoaPods 进行安装，具体步骤如下：

1. 安装 CocoaPods：

   $ gem install cocoapods
   

2. 在 Podfile 中添加 SignalR-ObjC：

   source 'https://github.com/CocoaPods/Specs.git'
   platform :ios, '8.0'
   
   pod 'SignalR-ObjC', '~> 2.0'
   

3. 运行安装命令：

   $ pod install
   

通过以上步骤，你就可以在你的项目中使用 SignalR-ObjC 了。