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

Represents a topic status message. More...

Inheritance diagram for PushTechnology.Transports.TopicStatusMessage:
PushTechnology.Transports.TopicMessage

Public Member Functions

 TopicStatusMessage (string topic, string topicStatus)
 Constructor. More...
 
- Public Member Functions inherited from PushTechnology.Transports.TopicMessage
 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

string Status [get, set]
 The string indicating the type of topic status. More...
 
string Alias [get, set]
 The string indicating the alias (if any) for the topic. More...
 
- Properties inherited from PushTechnology.Transports.TopicMessage
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 topic status message.

Constructor & Destructor Documentation

PushTechnology.Transports.TopicStatusMessage.TopicStatusMessage ( string  topic,
string  topicStatus 
)

Constructor.

Parameters
topic
topicStatus

Property Documentation

string PushTechnology.Transports.TopicStatusMessage.Alias
getset

The string indicating the alias (if any) for the topic.

string PushTechnology.Transports.TopicStatusMessage.Status
getset

The string indicating the type of topic status.


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