eFTLMessage Class Reference

Message objects contain typed fields that map names to values. More...

Inheritance diagram for eFTLMessage:

Public Types
enum	eFTLFieldType
	Message field types. More...

Instance Methods
(NSArray *)	- getDateArrayField:
	Get the value of a date array field from a message. More...
(NSDate *)	- getDateField:
	Get the value of a date field from a message. More...
(NSArray *)	- getDoubleArrayField:
	Get the value of a double array field from a message. More...
(NSNumber *)	- getDoubleField:
	Get the value of a double field from a message. More...
(NSArray *)	- getFieldNames
	Get the names of all fields present in a message. More...
(eFTLFieldType)	- getFieldType:
	Get the type of a message field. More...
(NSArray *)	- getLongArrayField:
	Get the value of a long array field from a message. More...
(NSNumber *)	- getLongField:
	Get the value of a long field from a message. More...
(NSArray *)	- getMessageArrayField:
	Get the value of a message array field from a message. More...
(eFTLMessage *)	- getMessageField:
	Get the value of a sub-message field from a message. More...
(NSData *)	- getOpaqueField:
	Get the value of an opaque field from a message. More...
(NSArray *)	- getStringArrayField:
	Get the value of a string array field from a message. More...
(NSString *)	- getStringField:
	Get the value of a string field from a message. More...
(BOOL)	- isFieldSet:
	Determine whether a field is present in the message. More...
(void)	- setField:asDate:
	Set a date field in a message. More...
(void)	- setField:asDateArray:
	Set a date array field in a message. More...
(void)	- setField:asDouble:
	Set a double field in a message. More...
(void)	- setField:asDoubleArray:
	Set a double array field in a message. More...
(void)	- setField:asLong:
	Set a long field in a message. More...
(void)	- setField:asLongArray:
	Set a long array field in a message. More...
(void)	- setField:asMessage:
	Set a sub-message field in a message. More...
(void)	- setField:asMessageArray:
	Set a message array field in a message. More...
(void)	- setField:asOpaque:
	Set an opaque field in a message. More...
(void)	- setField:asString:
	Set a string field in the message. More...
(void)	- setField:asStringArray:
	Set a string array field in a message. More...

Class Methods
(eFTLMessage *)	+ message
	Create an eFTLMessage. More...

Public Attributes
NSString *const	eFTLFieldNameDestination
	Message field name identifying the destination on which messages are published. More...

Detailed Description

Message objects contain typed fields that map names to values.

Member Enumeration Documentation

eFTLFieldType

- (enum) eFTLFieldType

Message field types.

Enumerates the legal types for eFTL message fields.

Method Documentation

getDateArrayField:()

- (NSArray *) getDateArrayField:

(NSString *)

name

Get the value of a date array field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeDateArray; nil otherwise.

getDateField:()

- (NSDate *) getDateField:

(NSString *)

name

Get the value of a date field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeDate; nil otherwise.

getDoubleArrayField:()

- (NSArray *) getDoubleArrayField:

(NSString *)

name

Get the value of a double array field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeDoubleArray; nil otherwise.

getDoubleField:()

- (NSNumber *) getDoubleField:

(NSString *)

name

Get the value of a double field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeDouble; nil otherwise.

getFieldNames()

- (NSArray *) getFieldNames

Get the names of all fields present in a message.

Returns

An array of field names.

getFieldType:()

- (eFTLFieldType) getFieldType:

(NSString *)

name

Get the type of a message field.

Parameters

name	The name of the field.

Returns

The type of the field, if present; nil otherwise.

getLongArrayField:()

- (NSArray *) getLongArrayField:

(NSString *)

name

Get the value of a long array field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeLongArray; nil otherwise.

getLongField:()

- (NSNumber *) getLongField:

(NSString *)

name

Get the value of a long field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeLong; nil otherwise.

getMessageArrayField:()

- (NSArray *) getMessageArrayField:

(NSString *)

name

Get the value of a message array field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeMessageArray; nil otherwise.

getMessageField:()

- (eFTLMessage *) getMessageField:

(NSString *)

name

Get the value of a sub-message field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeMessage; nil otherwise.

getOpaqueField:()

- (NSData *) getOpaqueField:

(NSString *)

name

Get the value of an opaque field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeOpaque; nil otherwise.

getStringArrayField:()

- (NSArray *) getStringArrayField:

(NSString *)

name

Get the value of a string array field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeStringArray; nil otherwise.

getStringField:()

- (NSString *) getStringField:

(NSString *)

name

Get the value of a string field from a message.

Parameters

name	Get this field.

Returns

The value of the field, if the field is present and has type eFTLFieldTypeString; nil otherwise.

isFieldSet:()

- (BOOL) isFieldSet:

(NSString *)

name

Determine whether a field is present in the message.

Parameters

name	The method checks for this field.

Returns

YES if the field is present; NO otherwise.

message()

+ (eFTLMessage *) message

Create an eFTLMessage.

Returns

A new eFTLMessage.

setField:asDate:()

- (void) setField:		(NSString *)	name
asDate:		(NSDate *)	date

Set a date field in a message.

Parameters

name	The call sets this field.
date	The call sets this value. To remove the field, supply nil.

setField:asDateArray:()

- (void) setField:		(NSString *)	name
asDateArray:		(NSArray *)	dateArray

Set a date array field in a message.

This method makes an independent copy of the array, and adds the copy to the message.
After this method returns you can safely modify the original array.

Parameters

name	The call sets this field.
dateArray	The call sets this value. To remove the field, supply nil.

setField:asDouble:()

- (void) setField:		(NSString *)	name
asDouble:		(NSNumber *)	number

Set a double field in a message.

Parameters

name	The call sets this field.
number	The call sets this value. To remove the field, supply nil.

setField:asDoubleArray:()

- (void) setField:		(NSString *)	name
asDoubleArray:		(NSArray *)	numberArray

Set a double array field in a message.

This method makes an independent copy of the array, and adds the copy to the message.
After this method returns you can safely modify the original array.

Parameters

name	The call sets this field.
numberArray	The call sets this value. To remove the field, supply nil.

setField:asLong:()

- (void) setField:		(NSString *)	name
asLong:		(NSNumber *)	number

Set a long field in a message.

Parameters

name	The call sets this field.
number	The call sets this value. To remove the field, supply nil.

setField:asLongArray:()

- (void) setField:		(NSString *)	name
asLongArray:		(NSArray *)	numberArray

Set a long array field in a message.

This method makes an independent copy of the array, and adds the copy to the message.
After this method returns you can safely modify the original array.

Parameters

name	The call sets this field.
numberArray	The call sets this value. To remove the field, supply nil.

setField:asMessage:()

- (void) setField:		(NSString *)	name
asMessage:		(eFTLMessage *)	message

Set a sub-message field in a message.

This method makes an independent copy of the sub-message, and adds the copy to the message.
After this method returns you can safely modify the original sub-message and its contents.

Parameters

name	The call sets this field.
message	The call sets this value. To remove the field, supply nil.

setField:asMessageArray:()

- (void) setField:		(NSString *)	name
asMessageArray:		(NSArray *)	messageArray

Set a message array field in a message.

This method makes an independent copy of the array and messages, and adds the copy to the message. After this method returns you can safely modify the original array and its contents.

Parameters

name	The call sets this field.
messageArray	The call sets this value. To remove the field, supply nil.

setField:asOpaque:()

- (void) setField:		(NSString *)	name
asOpaque:		(NSData *)	data

Set an opaque field in a message.

Parameters

name	The call sets this field.
data	The call sets this value. To remove the field, supply nil.

setField:asString:()

- (void) setField:		(NSString *)	name
asString:		(NSString *)	string

Set a string field in the message.

Parameters

name	The call sets this field.
string	The call sets this value. To remove the field, supply nil.

setField:asStringArray:()

- (void) setField:		(NSString *)	name
asStringArray:		(NSArray *)	stringArray

Set a string array field in a message.

This method makes an independent copy of the array and strings, and adds the copy to the message. After this method returns you can safely modify the original array and its contents.

Parameters

name	The call sets this field.
stringArray	The call sets this value. (Null is not a legal value within this array.) To remove the field, supply nil.

Member Data Documentation

eFTLFieldNameDestination

- (NSString* const) eFTLFieldNameDestination

Message field name identifying the destination on which messages are published.

To publish a message on a specific destination include this message field using setField:asString:.

To subscribe to messages published on a specific destination use a matcher that includes this message field name.

---

The documentation for this class was generated from the following file:

• eFTLMessage.h