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.Messages.Fault Class Reference

Class for creating fault messages. More...

Inherits PreEmptive.Analytics.Common.Message.

Public Member Functions

 Fault (IPlatform platform, ExceptionInfo exceptionInfo, Guid session, ExtendedKeys keys=null, BinaryInfoTag binary=null, bool includeAppComponents=true)
 Constructor for the fault message. More...
 
- Public Member Functions inherited from PreEmptive.Analytics.Common.Message
 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 IList< StackInfoGetStackInfo (string stackTrace, string customStackTraceRegex=null)
 Processes the string representation of a stack trace. More...
 
- Static Public Member Functions inherited from PreEmptive.Analytics.Common.Message
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 fault message. More...
 
override string TagDescription [get]
 A more descriptive name for exception messages. More...
 
- Properties inherited from PreEmptive.Analytics.Common.Message
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 fault messages.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.Messages.Fault.Fault ( IPlatform  platform,
ExceptionInfo  exceptionInfo,
Guid  session,
ExtendedKeys  keys = null,
BinaryInfoTag  binary = null,
bool  includeAppComponents = true 
)

Constructor for the fault message.

Parameters
platformPlatform specific implementations of methods for retrieving stack information.
exceptionInfoInformation describing the exception.
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.
includeAppComponentsif true, the Fault Message will add in memory appcomponents to the tag, otherwise false. Defaults to true.

Member Function Documentation

static IList<StackInfo> PreEmptive.Analytics.Common.Messages.Fault.GetStackInfo ( string  stackTrace,
string  customStackTraceRegex = null 
)
static

Processes the string representation of a stack trace.

Parameters
stackTraceString representation of the stack trace.
customStackTraceRegexOptional custom regex for processing the stack trace.
Returns
IList of StackInfo that represents the stack trace.

Property Documentation

override string PreEmptive.Analytics.Common.Messages.Fault.TagDescription
get

A more descriptive name for exception messages.

override string PreEmptive.Analytics.Common.Messages.Fault.TagName
get

Name of the tag for the fault message.


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