qrpc-iOS

一个 iOS 库，允许 iOS 客户端访问 qRPC 服务。您可以在这里了解更多关于 qRPC 的信息。

安装

pod 'InnotechIMSDK/Protocol'

使用

初始化

/**
实例方法

@param delegate InnotechIMProtocol
@param queue 代理回调所处线程
@return instance
*/
- (instancetype)initWithDelegate:(id<InnotechIMProtocol>)delegate delegateQueue:(dispatch_queue_t)queue NS_DESIGNATED_INITIALIZER;

连接/断开

/**
连接server

@param host host
@param port port
@param errPtr errPtr
@return result
*/
- (BOOL)connectToHost:(NSString*)host onPort:(uint16_t)port error:(NSError **)errPtr;

/**
断开连接
*/
- (void)disconnect;

发送数据包

/**
发送指令消息

@param cmd 指令
@param params 参数
@param sendProgress 发送进度
@param sendCompeletion 发送完成
@param receiveHandler 接收到resp时，可能会需要外层处理这些数据，处理过后需要通过`completion`block通知协议层已处理完毕
@param completion 处理完resp时
@return INXSCommandInfo instance
*/
- (INXSCommandInfo *)sendDataByCMD:(int32_t)cmd
andParams:(NSString * _Nullable)params
sendProgress:(InnotechIMProtocolProgressBlock _Nullable)sendProgress
sendCompeletion:(InnotechIMProtocolCompeletionBlock _Nullable)sendCompeletion
receiveHandler:(InnotechIMProtocolReceiveHandler _Nullable)receiveHandler
completion:(InnotechIMProtocolCompeletionBlock _Nullable)completion;

重连

/**
设置是否开启自动重连

@discussion 开启重连后，内部会在断开连接后尝试重连5次，失败后才会回调`protocolManagerDidDisconnect:withError:`，默认开启
@param aSwitch 开关
*/
- (void)setAutoReconnectEnabled:(BOOL)aSwitch;

/**
设置重连阻断指令

@discussion 因发送阻断指令而导致断开连接时，不再继续尝试重连
@param cmds 可选类型（`NS_OPTION`）的指令集
*/
- (void)setReconnectBlockingCommand:(NSInteger)cmds;

/**
设置重连次数

@param count `-1`表示无限重连，默认5
*/
- (void)setReconnectCount:(NSInteger)count;

代理

@protocol InnotechIMProtocol <NSObject>

/**
成功连接

@param manager InnotechIMProtocolManager
@param host host
@param port port
*/
- (void)protocolManager:(InnotechIMProtocolManager *)manager didConnectToHost:(NSString *)host port:(uint16_t)port;

/**
断开连接

@param manager InnotechIMProtocolManager
@param err error
*/
- (void)protocolManagerDidDisconnect:(InnotechIMProtocolManager *)manager withError:(NSError *)err;
@optional

/**
收到数据流

@discussion 该方法与发送指令方法中的`receiveHandler`有同样的作用，供上层在收到resp后对resp data进行处理
只需存在一种处理就好，优先使用block
无论block形式还是delegate形式的处理,都需要上层在处理完resp data后自行调用INXSCommandInfo.completion，用以dequeue数据流队列。该completion也是发送指令时传入的completion。

@param manager InnotechIMProtocolManager
@param info 收到的数据流信息
*/
- (void)protocolManager:(InnotechIMProtocolManager *)manager didReadData:(INXSCommandInfo *)info;
/**
即将重连

@discussion 只有开启自动重连功能才会回调此方法，且5次重连过程中只会回调一次。
@param manager InnotechIMProtocolManager
*/
- (void)protocolManagerWillReconnect:(InnotechIMProtocolManager *)manager;
@end