IOS Streaming Browser 1.0
An IOS streaming browser to stream the display to others or to a projector

HTTPMessage Class Reference

#import <HTTPMessage.h>

Public Member Functions

(id) - initEmptyRequest
(id) - initRequestWithMethod:URL:version:
(id) - initResponseWithStatusCode:description:version:
(BOOL) - appendData:
(BOOL) - isHeaderComplete
(NSString *) - version
(NSString *) - method
(NSURL *) - url
(NSInteger) - statusCode
(NSDictionary *) - allHeaderFields
(NSString *) - headerField:
(void) - setHeaderField:value:
(NSData *) - messageData
(NSData *) - body
(void) - setBody:

Protected Attributes

CFHTTPMessageRef message

Detailed Description

Definition at line 16 of file HTTPMessage.h.


Member Function Documentation

- (NSDictionary *) allHeaderFields

Gets all the header fields wrapped in an NSDictionary object

Gets a CFDictionary containing all of the header fields. returns NSDictionary

Definition at line 133 of file HTTPMessage.m.

{
    // Returns a CFDictionary containing all of the header fields.
        return [NSMakeCollectable(CFHTTPMessageCopyAllHeaderFields(message)) autorelease];
}
- (BOOL) appendData: (NSData *)  data

Returns whether can appendData with data param NSData

Returns whether can appendData to a message param NSData

Definition at line 70 of file HTTPMessage.m.

                  :(NSData *)data
{
    // Append date to the HTTP message
        return CFHTTPMessageAppendBytes(message, [data bytes], [data length]);
}
- (NSData *) body

Returns the body data returns NSData

Gets the message body returns NSData

Definition at line 179 of file HTTPMessage.m.

{
        return [NSMakeCollectable(CFHTTPMessageCopyBody(message)) autorelease];
}
- (NSString *) headerField: (NSString *)  headerField

Returns the header field as a string param NSString returns NSString

Gets a speicific header field param NSString returns NSString

Definition at line 145 of file HTTPMessage.m.

                         :(NSString *)headerField
{
        return [NSMakeCollectable(CFHTTPMessageCopyHeaderFieldValue(message, (CFStringRef)headerField)) autorelease];
}
- (id) initEmptyRequest

Initialize an empty HTTP message returns id

Initialize the HTTPMessage with an empty message returns self as an empty HTTP message

Definition at line 11 of file HTTPMessage.m.

{
        if ((self = [super init]))
        {
        // Create an empty HTTP message
                message = CFHTTPMessageCreateEmpty(NULL, YES);
        }
        return self;
}
- (id) initRequestWithMethod: (NSString *)  method
URL: (NSURL *)  url
version: (NSString *)  version 

Initialize a request HTTPMessage with a URL and version param NSString param NSURL param NSString returns id - self (HTTPMessage)

Initialize a request HTTPMessage with a URL and version param NSString param NSURL param NSString returns self (HTTPMessage)

Definition at line 28 of file HTTPMessage.m.

                           :(NSString *)method URL:(NSURL *)url version:(NSString *)version
{
        if ((self = [super init]))
        {
        // Create an http message with a method, url, and version
                message = CFHTTPMessageCreateRequest(NULL, (CFStringRef)method, (CFURLRef)url, (CFStringRef)version);
        }
        return self;
}
- (id) initResponseWithStatusCode: (NSInteger)  code
description: (NSString *)  description
version: (NSString *)  version 

Initialize a response HTTPMessage with a code, description, and version param NSString param NSString param NSString returns id

Initialize a response HTTPMessage with a code, description, and version param NSSInteger param NSString param NSSTring

Definition at line 44 of file HTTPMessage.m.

                                :(NSInteger)code description:(NSString *)description version:(NSString *)version
{
        if ((self = [super init]))
        {
        // Create an empty HTTP message with a code, description and version 
                message = CFHTTPMessageCreateResponse(NULL, (CFIndex)code, (CFStringRef)description, (CFStringRef)version);
        }
        return self;
}
- (BOOL) isHeaderComplete

Returns whether the header is complete

Whether the header is complete returns BOOL

Definition at line 80 of file HTTPMessage.m.

{
    // Test whether the http message header is complete
        return CFHTTPMessageIsHeaderComplete(message);
}
- (NSData *) messageData

Returns the message data returns NSData

Gets the message data returns NSData

Definition at line 168 of file HTTPMessage.m.

{
    
        return [NSMakeCollectable(CFHTTPMessageCopySerializedMessage(message)) autorelease];
}
- (NSString *) method

Gets the method

Gets the method returns NSSTring

Definition at line 101 of file HTTPMessage.m.

{
    
        return [NSMakeCollectable(CFHTTPMessageCopyRequestMethod(message)) autorelease];
}
- (void) setBody: (NSData *)  body

Set the body data param NSData

Sets the message body param NSData

Definition at line 189 of file HTTPMessage.m.

               :(NSData *)body
{
    // Set the message body
        CFHTTPMessageSetBody(message, (CFDataRef)body);
}
- (void) setHeaderField: (NSString *)  headerField
value: (NSString *)  headerFieldValue 

Sets the header field param NSString param NSString

Sets a header field param NSString param NSString

Definition at line 156 of file HTTPMessage.m.

                      :(NSString *)headerField 
                 value:(NSString *)headerFieldValue
{
    
        CFHTTPMessageSetHeaderFieldValue(message, (CFStringRef)headerField, (CFStringRef)headerFieldValue);
}
- (NSInteger) statusCode

Gets the status code

Gets the status code returns NSInteger

Definition at line 122 of file HTTPMessage.m.

{
    // Returns the status code for the response as an integer
        return (NSInteger)CFHTTPMessageGetResponseStatusCode(message);
}
- (NSURL *) url

Gets the url

Gets the url returns NSURL

Definition at line 112 of file HTTPMessage.m.

{
        return [NSMakeCollectable(CFHTTPMessageCopyRequestURL(message)) autorelease];
}
- (NSString *) version

Gets the version

Gets the version returns NSString

Definition at line 91 of file HTTPMessage.m.

{
        return [NSMakeCollectable(CFHTTPMessageCopyVersion(message)) autorelease];
}

Field Documentation

- (CFHTTPMessageRef) message [protected]

message can be request or response

Definition at line 21 of file HTTPMessage.h.


The documentation for this class was generated from the following files:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Properties Defines