The class for data messages that are created for a specific topic.
More...
#import <DFTopicMessage.h>
|
NSArray * | userHeaders |
| The user headers found on this message, as an array of NSString objects.
|
|
NSArray * | records |
| Tokenises the message payload by <RD>, and returns the result as an array of NSString objects.
|
|
NSString * | topic |
| The topic of the message.
|
|
NSData * | asBytes |
| the message content
|
|
NSString * | asString |
| the message content as a UTF8 string
|
|
long | numberOfRecords |
| the number of records held in this message
|
|
NSString * | ackID |
| the Ack ID for this message, nil if not set
|
|
int | ackTimeout |
| The timeout in seconds.
|
|
int | encoding |
| An encoding method to use for this message.
|
|
BOOL needsAcknowledge | DEPRECATED_ATTRIBUTE |
|
BOOL | isAckPending |
| YES if this iOS client implementation needs to acknowledge receipt, and has not yet.
|
|
BOOL | isAckRequired |
| YES, if the server needs to acknowledge receipt, once this message is transmitted.
|
|
BOOL | isInitialLoad |
| YES if the message is an initialTopicLoad message.
|
|
BOOL | isDelta |
| YES if the message is a delta message.
|
|
BOOL | isAckMessage |
| YES if this message requires acknowlegement from the client.
|
|
BOOL | isServiceLoad |
| YES if this message is a service-topic-load.
|
|
BOOL | isPagedLoad |
| YES if a load message on a 'paged' Topic.
|
|
BOOL | isTopicNotifyLoad |
| YES if a load message on a 'topic notify' Topic.
|
|
The class for data messages that are created for a specific topic.
getAckRequired
- Returns
- YES if an Ack is required from the server once this message is transmitted.
- Deprecated:
- in favor of property isAckRequired
- (NSArray *) getFields: |
|
(int) |
index |
|
Fetch the given record as an NSArray of NSData*.
- Parameters
-
- Returns
- An NSArray* holding the fields
- (long) getNumberOfRecords |
|
|
|
- Returns
- the number of records held in this message
- Deprecated:
- in favor of property numberOfRecords
- (id) initWithTopic: |
|
(NSString *) |
topic |
andData: |
|
(NSData *) |
message |
|
|
| |
Initialiase a TopicMessage object.
- Parameters
-
topic | Topic for this message |
message | Content of the message |
- Returns
- A newly initialiased object ready for sending
- (id) initWithTopic: |
|
(NSString *) |
topic |
andString: |
|
(NSString *) |
message |
|
|
| |
Initialiase a TopicMessage object.
- Parameters
-
topic | Topic for this message |
message | String content of the message |
- Returns
- A newly initialiased object ready for sending
- (NSString *) setAckRequired: |
|
(int) |
timeout |
|
Set the server-acknowledgement timeout, once this message is transmitted.
- Parameters
-
- Returns
- a newly generated AckID
- (BOOL needsAcknowledge) DEPRECATED_ATTRIBUTE |
|
readnonatomicassign |
An encoding method to use for this message.
Valid encoding values currently limited to DIFFUSION_MESSAGE_ENCODING_NONE_ENCODING, DIFFUSION_MESSAGE_ENCODING_ENCRYPTED_ENCODING or DIFFUSION_MESSAGE_ENCODING_COMPRESSED_ENCODING
YES if this iOS client implementation needs to acknowledge receipt, and has not yet.
The documentation for this class was generated from the following file: