Read the REST Response Body into a Stream

See more REST Examples

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

#import <CkoRest.h>
#import <CkoStringBuilder.h>
#import <CkoStream.h>

BOOL success = NO;

CkoRest *rest = [[CkoRest alloc] init];
BOOL bTls = YES;
BOOL bAutoReconnect = YES;
success = [rest Connect: @"example.com" port: [NSNumber numberWithInt: 443] tls: bTls autoReconnect: bAutoReconnect];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

//  The file paths are relative to the application's current working directory.  Absolute paths
//  may also be used.  Supply the paths appropriate to your own environment.

success = [rest SendReqNoBody: @"GET" uriPath: @"/api/images/1"];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

int statusCode = [[rest ReadResponseHeader] intValue];
if (statusCode < 0) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

//  Check for the expected success status code.  If the response is not 200, the body is likely
//  error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
//  read the body as text, report it, and return.
if (statusCode != 200) {
    CkoStringBuilder *sbError = [[CkoStringBuilder alloc] init];
    success = [rest ReadRespSb: sbError];
    if (success == NO) {
        NSLog(@"%@",rest.LastErrorText);
        return;
    }

    NSLog(@"%@%d",@"Request failed with status code ",statusCode);
    NSLog(@"%@",[sbError GetAsString]);
    return;
}

//  The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
//  file, which is appropriate for large or binary responses.
CkoStream *respStream = [[CkoStream alloc] init];
respStream.SinkFile = @"qa_output/image.png";

//  If the 2nd argument is true and the response is textual, the stream's character set is set from
//  the response Content-Type charset.  It has no effect for binary responses.
BOOL bAutoSetCharset = YES;
success = [rest ReadRespBodyStream: respStream autoSetStreamCharset: bAutoSetCharset];
if (success == NO) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

NSLog(@"%@",@"Response body written to the stream sink.");