[深入浅出Cocoa]iOS网络编程之CFNetwork

转载 2013年12月04日 22:56:33

[深入浅出Cocoa]iOS网络编程之CFNetwork

罗朝辉 (http://blog.csdn.net/kesalin/)

本文遵循“署名-非商业用途-保持一致”创作公用协议

 

一,CFNetwork 简介

首先来回顾下。在前文《[深入浅出Cocoa]iOS网络编程之Socket》中,提到iOS网络编程层次模型分为三层:

  • Cocoa层:NSURL,Bonjour,Game Kit,WebKit
  • Core Foundation层:基于 C 的 CFNetwork 和 CFNetServices
  • OS层:基于 C 的 BSD socket

前文讲的是最底层的 socket,本文将介绍位于 Core Foundation 中的 CFNetwork。CFNetwork 只是对 BSD socket 的进行了轻量级的封装,但在 iOS 中使用 CFNetwork 有一个显著的好处,那就是 CFNetwork 与系统级别的设置(如:天线设置)以及 run-loop 结合得很好。每一个线程都有自己的 run-loop,因此我们可以 CFNetwork 当中事件源加入到 run-loop 中,这样就可以在线程的 run-loop 中处理网络事件了。BTW,大名鼎鼎的 ASIHttpRequest 库就是基于 CFNetwork 封装的。


本文示例代码就是这样做的,源码请查看:

https://github.com/kesalin/iOSSnippet/tree/master/KSNetworkDemo

 

二,CFNetwork API 简介

CFNetwork 接口是基于 C 的,下面的接口用于创建一对 socket stream,一个用于读取,一个用于写入:

void CFStreamCreatePairWithSocketToHost(CFAllocatorRef alloc, CFStringRef host, UInt32 port, CFReadStreamRef *readStream, CFWriteStreamRef *writeStream);

该函数使用 host 以及 port,CFNetwork 会将该 host 转换为 IP 地址,并转换为网络字节顺序。如果我们只需要一个 socket stream,我们可以将另外一个设置为 NULL。还有另外两个“重载”的创建 socket sream的接口:CFStreamCreatePairWithSocket 和 CFStreamCreatePairWithPeerSocketSignature,在这里就不一一介绍了。

注意:在使用这些 socket stream 之前,必须显式地调用其 open 函数:

Boolean CFReadStreamOpen(CFReadStreamRef stream);

Boolean CFWriteStreamOpen(CFWriteStreamRef stream);

但与 socket 不同的是,这两个接口是异步的,当成功 open 之后,如果调用方设置了获取 kCFStreamEventOpenCompleted 事件的标志的话就会其调用回调函数。

而该回调函数及其参数设置是通过如下接口进行的:

Boolean CFReadStreamSetClient(CFReadStreamRef stream, CFOptionFlags streamEvents, CFReadStreamClientCallBack clientCB, CFStreamClientContext *clientContext);

Boolean CFWriteStreamSetClient(CFWriteStreamRef stream, CFOptionFlags streamEvents, CFWriteStreamClientCallBack clientCB, CFStreamClientContext *clientContext);

该函数用于设置回调函数及相关参数。通过 streamEvents 标志来设置我们对哪些事件感兴趣;clientCB 是一个回调函数,当事件标志对应的事件发生时,该回调函数就会被调用;clientContext 是用于传递参数到回调函数中去。

当设置好回调函数之后,我们可以将 socket stream 当做事件源调度到 run-loop 中去,这样 run-loop 就能分发该 socket stream 的网络事件了。

void CFReadStreamScheduleWithRunLoop(CFReadStreamRef stream, CFRunLoopRef runLoop, CFStringRef runLoopMode);

void CFWriteStreamScheduleWithRunLoop(CFWriteStreamRef stream, CFRunLoopRef runLoop, CFStringRef runLoopMode);

注意,在我们不再关心该 socket stream 的网络事件时,记得要调用如下接口将 socket stream 从 run-loop 的事件源中移除。

void CFReadStreamUnscheduleFromRunLoop(CFReadStreamRef stream, CFRunLoopRef runLoop, CFStringRef runLoopMode);

void CFWriteStreamUnscheduleFromRunLoop(CFWriteStreamRef stream, CFRunLoopRef runLoop, CFStringRef runLoopMode);

当我们将 socket stream 的网络事件调度到 run-loop 之后,我们就能在回调函数中相应各种事件,比如 kCFStreamEventHasBytesAvailable 读取数据:

Boolean CFReadStreamHasBytesAvailable(CFReadStreamRef stream);

CFIndex CFReadStreamRead(CFReadStreamRef stream, UInt8 *buffer, CFIndex bufferLength);

或 kCFStreamEventCanAcceptBytes 写入数据:

Boolean CFWriteStreamCanAcceptBytes(CFWriteStreamRef stream);

CFIndex CFWriteStreamWrite(CFWriteStreamRef stream,const UInt8 *buffer, CFIndex bufferLength);

最后,我们调用 close 方法关闭 socket stream:

void CFReadStreamClose(CFReadStreamRef stream);

void CFWriteStreamClose(CFWriteStreamRef stream);


三,客户端示例代码

与 socket 演示类似,在这里我只演示客户端示例。同样,我们也在一个后台线程中启动网络操作:


[html] view plaincopyprint?


  1.    NSURL * url = [NSURL URLWithString:[NSString stringWithFormat:@"%@:%@", serverHost, serverPort]];  
  2.    NSThread * backgroundThread = [[NSThread alloc] initWithTarget:self  
  3.                                                          selector:@selector(loadDataFromServerWithURL:)  
  4.                                                            object:url];  
  5. [backgroundThread start];  


然后在 loadDataFromServerWithURL 中创建 socket 流,并设置其回调函数,将其加入到 run-loop 的事件源中,然后启动之:


[cpp] view plaincopyprint?


  1. - (void)loadDataFromServerWithURL:(NSURL *)url  
  2. {  
  3.     NSString * host = [url host];  
  4.     NSInteger port = [[url port] integerValue];  
  5.       
  6.     // Keep a reference to self to use for controller callbacks  
  7.     //  
  8.     CFStreamClientContext ctx = {0, (__bridge void *)(self), NULL, NULL, NULL};  
  9.       
  10.     // Get callbacks for stream data, stream end, and any errors  
  11.     //  
  12.     CFOptionFlags registeredEvents = (kCFStreamEventHasBytesAvailable | kCFStreamEventEndEncountered | kCFStreamEventErrorOccurred);  
  13.       
  14.     // Create a read-only socket  
  15.     //  
  16.     CFReadStreamRef readStream;  
  17.     <strong>CFStreamCreatePairWithSocketToHost</strong>(kCFAllocatorDefault, (__bridge CFStringRef)host, port, &readStream, NULL);  
  18.       
  19.     // Schedule the stream on the run loop to enable callbacks  
  20.     //  
  21.     if (<strong>CFReadStreamSetClient</strong>(readStream, registeredEvents, socketCallback, &ctx)) {  
  22.         <strong>CFReadStreamScheduleWithRunLoop</strong>(readStream, CFRunLoopGetCurrent(), kCFRunLoopCommonModes);  
  23.           
  24.     }  
  25.     else {  
  26.         [self networkFailedWithErrorMessage:@"Failed to assign callback method"];  
  27.         return;  
  28.     }  
  29.       
  30.     // Open the stream for reading  
  31.     //  
  32.     if (<strong>CFReadStreamOpen</strong>(readStream) == NO) {  
  33.         [self networkFailedWithErrorMessage:@"Failed to open read stream"];  
  34.           
  35.         return;  
  36.     }  
  37.       
  38.     CFErrorRef error = <strong>CFReadStreamCopyError</strong>(readStream);  
  39.     if (error != NULL) {  
  40.         if (CFErrorGetCode(error) != 0) {  
  41.             NSString * errorInfo = [NSString stringWithFormat:@"Failed to connect stream; error '%@' (code %ld)", (__bridge NSString*)CFErrorGetDomain(error), CFErrorGetCode(error)];  
  42.             [self networkFailedWithErrorMessage:errorInfo];  
  43.         }  
  44.           
  45.         CFRelease(error);  
  46.           
  47.         return;  
  48.     }  
  49.       
  50.     NSLog(@"Successfully connected to %@", url);  
  51.       
  52.     // Start processing  
  53.     //  
  54.     <strong>CFRunLoopRun</strong>();  
  55. }  


参考前面的接口说明,相信你不难理解上面的代码。前面唯一没有提到的接口就是 CFReadStreamCopyError,该接口用于获取当前的错误信息,如果没有错误则返回 NULL。


CFErrorRef CFReadStreamCopyError(CFReadStreamRef stream);

CFErrorRef CFWriteStreamCopyError(CFWriteStreamRef stream);

此外,我们还可以调用如下接口获取 socket stream 的当前状态:

CFStreamStatus CFReadStreamGetStatus(CFReadStreamRef stream);

CFStreamStatus CFWriteStreamGetStatus(CFWriteStreamRef stream);

在上面的代码中,我们设置了当有数据可以读取,流到达结尾处时以及错误发生时调用回调函数 socketCallback:


[html] view plaincopyprint?


  1. void socketCallback(CFReadStreamRef stream, CFStreamEventType event, void * myPtr)  
  2. {  
  3.     KSCFNetworkViewController * controller = (__bridge KSCFNetworkViewController *)myPtr;  
  4.       
  5.     switch(event) {  
  6.         case kCFStreamEventHasBytesAvailable: {  
  7.             // Read bytes until there are no more  
  8.             //  
  9.             while (<strong>CFReadStreamHasBytesAvailable</strong>(stream)) {  
  10.                 UInt8 buffer[kBufferSize];  
  11.                 int numBytesRead = <strong>CFReadStreamRead</strong>(stream, buffer, kBufferSize);  
  12.                   
  13.                 [controller didReceiveData:[NSData dataWithBytes:buffer length:numBytesRead]];  
  14.             }  
  15.               
  16.             break;  
  17.         }  
  18.               
  19.         case kCFStreamEventErrorOccurred: {  
  20.             CFErrorRef error = <strong>CFReadStreamCopyError</strong>(stream);  
  21.             if (error != NULL) {  
  22.                 if (CFErrorGetCode(error) != 0) {  
  23.                     NSString * errorInfo = [NSString stringWithFormat:@"Failed while reading stream; error '%@' (code %ld)", (__bridge NSString*)CFErrorGetDomain(error), CFErrorGetCode(error)];  
  24.                       
  25.                     [controller networkFailedWithErrorMessage:errorInfo];  
  26.                 }  
  27.                   
  28.                 CFRelease(error);  
  29.             }  
  30.               
  31.               
  32.             break;  
  33.         }  
  34.               
  35.         case kCFStreamEventEndEncountered:  
  36.             // Finnish receiveing data  
  37.             //  
  38.             [controller didFinishReceivingData];  
  39.               
  40.             // Clean up  
  41.             //  
  42.             <strong>CFReadStreamClose</strong>(stream);  
  43.             <strong>CFReadStreamUnscheduleFromRunLoop</strong>(stream, CFRunLoopGetCurrent(), kCFRunLoopCommonModes);  
  44.             <strong>CFRunLoopStop</strong>(CFRunLoopGetCurrent());  
  45.               
  46.             break;  
  47.               
  48.         default:  
  49.             break;  
  50.     }  
  51. }  


上面的代码也很好理解,当有数据可以读取时,读取之,然后更新 UI;当流到达结尾处时,关闭流,执行清理工作;当错误发送时,报告错误信息。



四,扩展

虽然上面的代码只演示了如何使用 CFNetwork 的 CFReadStream 来读取数据,写入数据使用 CFWriteStream,其工作流程也是一样的。在这里就不再介绍了。更多《深入浅出Cocoa》系列文章,敬请访问CSDN专栏:http://blog.csdn.net/column/details/cocoa.html  

相关文章推荐

[深入浅出Cocoa]iOS网络编程之CFNetwork

[深入浅出Cocoa]iOS网络编程之CFNetwork 罗朝辉 (http://blog.csdn.net/kesalin/) 本文遵循“署名-非商业用途-保持一致”创作公用协议 ...
  • kesalin
  • kesalin
  • 2013年04月14日 20:59
  • 40616

[深入浅出Cocoa]iOS网络编程之CFNetwork

一,iOS网络编程层次模型 在前文《深入浅出Cocoa之Bonjour网络编程》中我介绍了如何在Mac系统下进行 Bonjour 编程,在那篇文章中也介绍过 Cocoa 中网络编程层次结...

[深入浅出Cocoa]iOS网络编程之CFNetwork

一,CFNetwork 简介 首先来回顾下。在前文《[深入浅出Cocoa]iOS网络编程之Socket》中,提到iOS网络编程层次模型分为三层: Cocoa层:NSURL,Bonjou...
  • mad2man
  • mad2man
  • 2013年10月10日 06:24
  • 1163

[深入浅出Cocoa]iOS网络编程之NSStream

[深入浅出Cocoa]iOS网络编程之NSStream 罗朝辉 (http://blog.csdn.net/kesalin/) 本文遵循“署名-非商业用途-保持一致”创作公用协议  ...
  • kesalin
  • kesalin
  • 2013年04月29日 20:06
  • 28387

[深入浅出Cocoa]iOS网络编程之Socket

[深入浅出Cocoa]iOS网络编程之Socket 罗朝辉 (http://blog.csdn.net/kesalin) CC 许可,转载请注明出处 更多 Coc...
  • kesalin
  • kesalin
  • 2013年04月13日 20:51
  • 63925

[深入浅出Cocoa]iOS网络编程之NSStream

[深入浅出Cocoa]iOS网络编程之NSStream 罗朝辉 (http://blog.csdn.net/kesalin/) 本文遵循“署名-非商业用途-保持一致”创作公用协议   一,NS...

[深入浅出Cocoa]iOS网络编程之Socket

[深入浅出Cocoa]iOS网络编程之Socket 罗朝辉 (http://blog.csdn.net/kesalin) CC 许可,转载请注明出处 更多 C...
  • limzoo
  • limzoo
  • 2016年08月08日 00:33
  • 395

[ios2] 深入浅出Cocoa之Bonjour网络编程【转】

http://www.cnblogs.com/kesalin/archive/2011/09/15/cocoa_bonjour.html 本文高度参考自 Tutorial: Networking a...

深入浅出 Cocoa 之 Bonjour 网络编程

本文高度参考自 Tutorial: Networking and Bonjour on iPhone,在那个帖子里 iphone 版本的代码采用的是 MIT 开源协议,所以本例子中的 Mac 版本...

IOS研究之网络编程(二)-Cocoa Streams使用详解

 本文以及相关的系列文章是我总结的iOS网络开发方面的知识点,本文是第二篇,主要分析了Cocoa Streams中的几个重要类 Cocoa Streams实际上是Objective-C对CFN...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:[深入浅出Cocoa]iOS网络编程之CFNetwork
举报原因:
原因补充:

(最多只允许输入30个字)