PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Properties | List of all members
PreEmptive.Analytics.Common.Message Class Reference

Class for creating messages. More...

Inherits PreEmptive.Analytics.Common.Tags.Tag.

Inherited by PreEmptive.Analytics.Common.Messages.ApplicationExpiration, PreEmptive.Analytics.Common.Messages.ApplicationStart, PreEmptive.Analytics.Common.Messages.ApplicationStop, PreEmptive.Analytics.Common.Messages.Fault, PreEmptive.Analytics.Common.Messages.PerformanceProbe, PreEmptive.Analytics.Common.Messages.SessionStart, PreEmptive.Analytics.Common.Messages.SessionStop, PreEmptive.Analytics.Common.Messages.SystemProfile, PreEmptive.Analytics.Common.Messages.Tamper, and PreEmptive.Analytics.Common.Tags.Feature.

Public Member Functions

 Message (Guid session, ExtendedKeys keys=null, BinaryInfoTag binary=null)
 Constructor for a message. More...
 
 Message (string messageType)
 Constructor for a message. More...
 
override string ToString (IAttributeLimiter limits)
 Converts the message to XML suitable for storage or transmission Note that messages are assumed to be immutable and ToString results are cached when used with "matching" field size limits More...
 
override string ToString ()
 Converts the message to XML suitable for storage or transmission Note that messages are assumed to be immutable and ToString results are cached when used with "matching" field size limits More...
 
override void AppendToStringBuilder (StringBuilder sb, IAttributeLimiter limits)
 Appends the serialized XML string to a StringBuilder More...
 
void InvalidateStringCache ()
 Use this to clear the cached serialized string This must be used if you serialize the message and then modify the message More...
 
- Public Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
 Tag ()
 Constructor for creating a Tag. More...
 
 Tag (string tagName)
 Constructor for creating a Tag. More...
 
override string ToString ()
 Converts the Tag object to an XML string. More...
 
void AddAttribute (string name, string value)
 Adds an attribute to the current Tag. More...
 
void AddOptionalAttribute (string name, string value)
 Adds an optional attribute to the current Tag. If the value provided is null, then the attribute will not be added. More...
 

Static Public Member Functions

static Message FromTag (Tag tag)
 Creates a new message from a Tag object. More...
 
- Static Public Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
static Tag FromString (string str)
 Creates a Tag object from an XML string. More...
 
static Tag FromReader (TextReader reader)
 Creates (deserializes) a Tag object from an XML string provided by a TextReader More...
 

Properties

override string TagName [get]
 Name of the tag for the message. More...
 
BinaryInfoTag BinaryInfo [get, set]
 Binary info that describes the application where the request originated. More...
 
- Properties inherited from PreEmptive.Analytics.Common.Tags.Tag
virtual string TagName [get]
 The name of the tag. More...
 
virtual string TagDescription [get]
 A more descriptive tag name. More...
 
List< TagInnerTags [get, set]
 A list of tags that are nested within this tag. More...
 

Additional Inherited Members

- Public Attributes inherited from PreEmptive.Analytics.Common.Tags.Tag
AttributeList Attributes = new AttributeList()
 The list of attributes that will be added to the Tag. More...
 
- Protected Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
virtual void AppendSerializedInnerTags (StringBuilder sb, IAttributeLimiter limits)
 Will serialize the inner tags and return them as a string More...
 
string Escape (string s, int?maxLength=null)
 Escapes characters from the given string More...
 
void AddOptionalAttribute< T > (string name, T value)
 Add an optional attribute to the current tag. If the value provided is null, then the attribute will not be added. More...
 
- Static Protected Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
static void AppendEscape (StringBuilder sb, string s, int?maxLength=null)
 Esxapes the characters in the given string and appends the escaped text to the provided StringBuilder More...
 

Detailed Description

Class for creating messages.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.Message.Message ( Guid  session,
ExtendedKeys  keys = null,
BinaryInfoTag  binary = null 
)

Constructor for a message.

Parameters
sessionA Guid that identifies the current session.
keysExtended key information to be sent with the message.
binaryBinary info that describes the application where the request originated.
PreEmptive.Analytics.Common.Message.Message ( string  messageType)

Constructor for a message.

Parameters
messageTypeName describing the message.

Member Function Documentation

override void PreEmptive.Analytics.Common.Message.AppendToStringBuilder ( StringBuilder  sb,
IAttributeLimiter  limits 
)
virtual

Appends the serialized XML string to a StringBuilder

Parameters
sbThe StringBuilder to append to
limitsThe field size limits of the upstream server

Reimplemented from PreEmptive.Analytics.Common.Tags.Tag.

static Message PreEmptive.Analytics.Common.Message.FromTag ( Tag  tag)
static

Creates a new message from a Tag object.

Parameters
tagTag to convert into a message.
Returns
Resulting message
void PreEmptive.Analytics.Common.Message.InvalidateStringCache ( )

Use this to clear the cached serialized string This must be used if you serialize the message and then modify the message

override string PreEmptive.Analytics.Common.Message.ToString ( IAttributeLimiter  limits)
virtual

Converts the message to XML suitable for storage or transmission Note that messages are assumed to be immutable and ToString results are cached when used with "matching" field size limits

Parameters
limitsThe field size limits of the upstream server
Returns
The XML string

Reimplemented from PreEmptive.Analytics.Common.Tags.Tag.

override string PreEmptive.Analytics.Common.Message.ToString ( )

Converts the message to XML suitable for storage or transmission Note that messages are assumed to be immutable and ToString results are cached when used with "matching" field size limits

Returns
The XML string

Property Documentation

BinaryInfoTag PreEmptive.Analytics.Common.Message.BinaryInfo
getset

Binary info that describes the application where the request originated.

override string PreEmptive.Analytics.Common.Message.TagName
get

Name of the tag for the message.


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