#import <BLIPMessage.h>
Inherited by BLIPRequest, and BLIPResponse.
Public Member Functions | |
| (void) | - addToBody: |
| Appends data to the body. | |
| (NSString *) | - valueOfProperty: |
| A shortcut to get the value of a property. | |
| (void) | - setValue:ofProperty: |
| A shortcut to set the value of a property. | |
Properties | |
| readonly | |
| The BLIPConnection associated with this message. | |
| readonly UInt32 | number |
| This message's serial number in its connection. | |
| readonly BOOL | isMine |
| Is this a message sent by me (as opposed to the peer)? | |
| readonly BOOL | sent |
| Has this message been sent yet? (Only makes sense when isMe is set. | |
| readonly BOOL | propertiesAvailable |
| Has enough of the message arrived to read its properies? | |
| readonly BOOL | complete |
| Has the entire message, including the body, arrived? | |
| BOOL | compressed |
| Should the message body be compressed with gzip? This property can only be set before sending the message. | |
| BOOL | urgent |
| Should the message be sent ahead of normal-priority messages? This property can only be set before sending the message. | |
| readonly BOOL | isMutable |
| Can this message be changed? (Only true for outgoing messages, before you send them. | |
| copy NSData * | body |
| The message body, a blob of arbitrary data. | |
| copy NSString * | bodyString |
| The message body as an NSString. | |
| readonly BLIPProperties * | properties |
| The message's properties, a dictionary-like object. | |
| readonly BLIPMutableProperties * | mutableProperties |
| Mutable version of the message's properties; only available if this mesage is mutable. | |
| copy NSString * | contentType |
| The value of the "Content-Type" property, which is by convention the MIME type of the body. | |
| copy NSString * | profile |
| The value of the "Profile" property, which by convention identifies the purpose of the message. | |
| readonly NSString * | descriptionWithProperties |
| Similar to -description, but also shows the properties and their values. | |
| - (void) addToBody: | (NSData*) | data |
Appends data to the body.
| - (NSString *) valueOfProperty: | (NSString*) | property |
A shortcut to get the value of a property.
| - (void) setValue: | (NSString*) | value | ||
| ofProperty: | (NSString*) | property | ||
A shortcut to set the value of a property.
A nil value deletes that property.
- BLIPMessage: [protected] |
The BLIPConnection associated with this message.
- (readonly UInt32) number [protected] |
This message's serial number in its connection.
A BLIPRequest's number is initially zero, then assigned when it's sent. A BLIPResponse is automatically assigned the same number as the request it replies to.
- (readonly BOOL) sent [protected] |
Has this message been sent yet? (Only makes sense when isMe is set.
)
- (BOOL) compressed [protected] |
Should the message body be compressed with gzip? This property can only be set before sending the message.
- (BOOL) urgent [protected] |
Should the message be sent ahead of normal-priority messages? This property can only be set before sending the message.
- (readonly BOOL) isMutable [protected] |
Can this message be changed? (Only true for outgoing messages, before you send them.
)
- (NSData *) body [protected] |
The message body, a blob of arbitrary data.
| - (NSString *) bodyString |
The message body as an NSString.
The UTF-8 character encoding is used to convert.
| - (BLIPProperties *) properties |
The message's properties, a dictionary-like object.
Message properties are much like the headers in HTTP, MIME and RFC822.
| - (BLIPMutableProperties *) mutableProperties |
Mutable version of the message's properties; only available if this mesage is mutable.
| - (NSString *) contentType |
The value of the "Content-Type" property, which is by convention the MIME type of the body.
| - (NSString *) profile |
The value of the "Profile" property, which by convention identifies the purpose of the message.
| - (NSString *) descriptionWithProperties |
Similar to -description, but also shows the properties and their values.
1.5.4