github/GCDWebServer
3
0
Fork 0
mirror of https://github.com/swisspol/GCDWebServer.git synced 2026-07-08 00:00:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed incorrect documentation for GCDWebServerAsyncStreamBlock

Browse Source
This commit is contained in:
Pierre-Olivier Latour
2015-01-02 18:55:30 -08:00
parent 3618dcac7e
commit 33645d3c6b
3 changed files with 18 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
GCDWebServer/Responses/GCDWebServerStreamedResponse.h
+5 -8
View File
@@ -29,8 +29,8 @@
/**
* The GCDWebServerStreamBlock is called to stream the data for the HTTP body.
* The block must return empty NSData when done or nil on error and set the
* "error" argument which is guaranteed to be non-NULL.
* The block must return either a chunk of data, an empty NSData when done, or
* nil on error and set the "error" argument which is guaranteed to be non-NULL.
*/
typedef NSData* (^GCDWebServerStreamBlock)(NSError** error);
@@ -39,13 +39,10 @@ typedef NSData* (^GCDWebServerStreamBlock)(NSError** error);
* except the streamed data can be returned at a later time allowing for
* truly asynchronous generation of the data.
*
* The block must return empty NSData when done or nil on error and set the
* "error" argument which is guaranteed to be non-NULL.
* The block must call "completionBlock" passing the new chunk of data when ready,
* an empty NSData when done, or nil on error and pass a NSError.
*
* The block must regularly call "completionBlock" passing new streamed data.
* Eventually it must call "completionBlock" passing an empty NSData indicating
* the end of the stream has been reached, or pass nil and an NSError in case of
* error.
* The block cannot call "completionBlock" more than once per invocation.
*/
typedef void (^GCDWebServerAsyncStreamBlock)(GCDWebServerBodyReaderCompletionBlock completionBlock);