DEPRECATED: Diffusion Silverlight Classic API  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.Transports.TopicMessage Class Reference

Represents a Diffusion topic message. More...

Inheritance diagram for PushTechnology.Transports.TopicMessage:
PushTechnology.Transports.ClientAckMessage PushTechnology.Transports.ClientPingMessage PushTechnology.Transports.PingMessage PushTechnology.Transports.ServerAckMessage PushTechnology.Transports.TopicStatusMessage

Public Member Functions

 TopicMessage ()
 Default constructor. More...
 
 TopicMessage (string topicName, string message=null)
 Constructor. More...
 
string SetAckRequired (int timeout=2000)
 Indicates that this message requires acknowledgement. More...
 
void SetMessage (string message)
 Sets the message portion of the topic message. More...
 
void SetMessageAsBytes (ByteBuffer message)
 Sets a binary message to send to Diffusion. More...
 
ByteBuffer GetMessage ()
 Returns the payload of a message as a ByteBuffer. More...
 
int GetNumberOfRecords ()
 Returns the number of records in this message. More...
 
string[] GetFields (int recordIndex)
 Returns the array of fields in this message. More...
 
List< string > GetRecords ()
 Get the records of this message. More...
 
void SetAcknowledged ()
 Sets this message as 'acknowledged'. More...
 
string ToDisplayFormat ()
 Returns the message with human-readable record delimiters and field delimiters. More...
 

Properties

bool AckRequired [get, set]
 Is this an 'ack'-type message? More...
 
long AckTimeout [get, set]
 The timeout for the 'ack' message. More...
 
string AckId [get, set]
 Get/set the 'ack' id. More...
 
DiffusionMessageType MessageType [get, set]
 The type of message. More...
 
bool IsAckMessage [get]
 Is this an 'acknowledge' message type? More...
 
bool IsPagedLoad [get]
 Is this a 'paged load' message type? More...
 
bool IsServiceLoad [get]
 Is this a 'service' load message type? More...
 
bool IsServiceRequest [get]
 Is this a 'service request' message type? More...
 
string ClientId [get, set]
 The client id. More...
 
MessageEncodingType Encoding [get, set]
 The encoding of this message. More...
 
byte[] RawMessage [get]
 The raw message bytes. More...
 
string MessageAsString [get]
 The message as a string. More...
 
int Length [get]
 Returns the length of the message. More...
 
string TopicName [get, set]
 The topic of this message. More...
 
DateTime TimeStamp [get, set]
 The timestamp of this message. More...
 
bool IsInitialTopicLoad [get, set]
 Is this an initial topic load message? More...
 
bool IsFetchResponse [get, set]
 Is this a fetch response message? More...
 
bool IsDeltaMessage [get, set]
 Is this a delta message? More...
 
List< string > Headers [get, set]
 Get/set the headers of this message. More...
 
bool Acknowledged [set]
 Sets message acknowledgement. More...
 
bool NeedsAcknowledgement [get, set]
 Determines whether this message needs acknowledgement. More...
 

Detailed Description

Represents a Diffusion topic message.

Constructor & Destructor Documentation

PushTechnology.Transports.TopicMessage.TopicMessage ( )

Default constructor.

PushTechnology.Transports.TopicMessage.TopicMessage ( string  topicName,
string  message = null 
)

Constructor.

Parameters
topicNameThe name of the topic for this message.
messageThe message data.

Member Function Documentation

string [] PushTechnology.Transports.TopicMessage.GetFields ( int  recordIndex)

Returns the array of fields in this message.

Parameters
recordIndexThe index of the record to retrieve the fields from.
Returns
The array of fields in the record.
ByteBuffer PushTechnology.Transports.TopicMessage.GetMessage ( )

Returns the payload of a message as a ByteBuffer.

Returns
int PushTechnology.Transports.TopicMessage.GetNumberOfRecords ( )

Returns the number of records in this message.

Returns
List<string> PushTechnology.Transports.TopicMessage.GetRecords ( )

Get the records of this message.

Returns
void PushTechnology.Transports.TopicMessage.SetAcknowledged ( )

Sets this message as 'acknowledged'.

string PushTechnology.Transports.TopicMessage.SetAckRequired ( int  timeout = 2000)

Indicates that this message requires acknowledgement.

Parameters
timeoutThe period in milliseconds to wait for an ack response from the server.
Returns
The unique acknowledgement id.
void PushTechnology.Transports.TopicMessage.SetMessage ( string  message)

Sets the message portion of the topic message.

Parameters
message
void PushTechnology.Transports.TopicMessage.SetMessageAsBytes ( ByteBuffer  message)

Sets a binary message to send to Diffusion.

Parameters
message
string PushTechnology.Transports.TopicMessage.ToDisplayFormat ( )

Returns the message with human-readable record delimiters and field delimiters.

Returns

Property Documentation

string PushTechnology.Transports.TopicMessage.AckId
getset

Get/set the 'ack' id.

bool PushTechnology.Transports.TopicMessage.Acknowledged
set

Sets message acknowledgement.

bool PushTechnology.Transports.TopicMessage.AckRequired
getset

Is this an 'ack'-type message?

long PushTechnology.Transports.TopicMessage.AckTimeout
getset

The timeout for the 'ack' message.

string PushTechnology.Transports.TopicMessage.ClientId
getset

The client id.

MessageEncodingType PushTechnology.Transports.TopicMessage.Encoding
getset

The encoding of this message.

List<string> PushTechnology.Transports.TopicMessage.Headers
getset

Get/set the headers of this message.

bool PushTechnology.Transports.TopicMessage.IsAckMessage
get

Is this an 'acknowledge' message type?

bool PushTechnology.Transports.TopicMessage.IsDeltaMessage
getset

Is this a delta message?

bool PushTechnology.Transports.TopicMessage.IsFetchResponse
getset

Is this a fetch response message?

bool PushTechnology.Transports.TopicMessage.IsInitialTopicLoad
getset

Is this an initial topic load message?

bool PushTechnology.Transports.TopicMessage.IsPagedLoad
get

Is this a 'paged load' message type?

bool PushTechnology.Transports.TopicMessage.IsServiceLoad
get

Is this a 'service' load message type?

bool PushTechnology.Transports.TopicMessage.IsServiceRequest
get

Is this a 'service request' message type?

int PushTechnology.Transports.TopicMessage.Length
get

Returns the length of the message.

string PushTechnology.Transports.TopicMessage.MessageAsString
get

The message as a string.

DiffusionMessageType PushTechnology.Transports.TopicMessage.MessageType
getset

The type of message.

bool PushTechnology.Transports.TopicMessage.NeedsAcknowledgement
getset

Determines whether this message needs acknowledgement.

byte [] PushTechnology.Transports.TopicMessage.RawMessage
get

The raw message bytes.

DateTime PushTechnology.Transports.TopicMessage.TimeStamp
getset

The timestamp of this message.

string PushTechnology.Transports.TopicMessage.TopicName
getset

The topic of this message.


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