C# Класс Smrf.NodeXL.GraphDataProviders.HttpNetworkAnalyzerBase

Abstract base class for classes that analyze network information obtained via HTTP Web requests.
This base class implements properties related to HTTP Web requests, a BackgroundWorker instance, and properties, methods, and events related to the BackgroundWorker. The derived class must implement a method to start an analysis and implement the BackgroundWorker_DoWork method.
Наследование: Object
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
HttpRetryDelaysSec System.Int32[]
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

Открытые методы

Метод Описание
CancelAsync ( ) : void
CreateHttpWebRequest ( String url ) : HttpWebRequest
ExceptionToMessage ( Exception oException ) : String
HttpNetworkAnalyzerBase ( ) : System

Initializes a new instance of the class.

Защищенные методы

Метод Описание
AppendDoubleGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
AppendEdgeXmlNode ( GraphMLXmlDocument oGraphMLXmlDocument, String sVertex1ID, String sVertex2ID, String sRelationship ) : XmlNode
AppendInt32GraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
AppendStringGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
CheckCancellationPending ( ) : void
CheckIsBusy ( String sMethodName ) : void
DefineCustomMenuGraphMLAttributes ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineImageFileGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineLabelGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
DefineRelationshipGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
ExceptionIsWebOrXml ( Exception oException ) : System.Boolean
FireProgressChanged ( ProgressChangedEventArgs e ) : void
GetNeedToAppendVertices ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
GetNeedToRecurse ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
GetXmlDocumentNoRetries ( HttpWebRequest oHttpWebRequest ) : XmlDocument
GetXmlDocumentWithRetries ( String sUrl, HttpStatusCode aeHttpStatusCodesToFailImmediately, RequestStatistics oRequestStatistics ) : XmlDocument
NetworkLevelToString ( NetworkLevel eNetworkLevel ) : String
OnNetworkObtained ( XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription, String sNetworkTitle ) : void
OnNetworkObtainedWithoutTerminatingException ( GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription ) : void
OnTerminatingException ( Exception oException ) : void
OnUnexpectedException ( Exception oException, XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
ReportProgress ( String sProgressMessage ) : void
WebExceptionHasHttpStatusCode ( WebException oWebException ) : System.Boolean

Приватные методы

Метод Описание
AssertValid ( ) : void

Описание методов

AppendDoubleGraphMLAttributeValue() защищенный Метод

protected AppendDoubleGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Результат System.Boolean

AppendEdgeXmlNode() защищенный Метод

protected AppendEdgeXmlNode ( GraphMLXmlDocument oGraphMLXmlDocument, String sVertex1ID, String sVertex2ID, String sRelationship ) : XmlNode
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
sVertex1ID String
sVertex2ID String
sRelationship String
Результат System.Xml.XmlNode

AppendInt32GraphMLAttributeValue() защищенный Метод

protected AppendInt32GraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Результат System.Boolean

AppendStringGraphMLAttributeValue() защищенный Метод

protected AppendStringGraphMLAttributeValue ( XmlNode oXmlNodeToSelectFrom, String sXPath, XmlNamespaceManager oXmlNamespaceManager, GraphMLXmlDocument oGraphMLXmlDocument, XmlNode oEdgeOrVertexXmlNode, String sGraphMLAttributeID ) : System.Boolean
oXmlNodeToSelectFrom System.Xml.XmlNode
sXPath String
oXmlNamespaceManager System.Xml.XmlNamespaceManager
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oEdgeOrVertexXmlNode System.Xml.XmlNode
sGraphMLAttributeID String
Результат System.Boolean

BackgroundWorker_DoWork() защищенный абстрактный Метод

protected abstract BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
Результат void

BackgroundWorker_ProgressChanged() защищенный Метод

protected BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
sender object
e System.ComponentModel.ProgressChangedEventArgs
Результат void

BackgroundWorker_RunWorkerCompleted() защищенный Метод

protected BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
sender object
e System.ComponentModel.RunWorkerCompletedEventArgs
Результат void

CancelAsync() публичный Метод

public CancelAsync ( ) : void
Результат void

CheckCancellationPending() защищенный Метод

protected CheckCancellationPending ( ) : void
Результат void

CheckIsBusy() защищенный Метод

protected CheckIsBusy ( String sMethodName ) : void
sMethodName String
Результат void

CreateHttpWebRequest() публичный статический Метод

public static CreateHttpWebRequest ( String url ) : HttpWebRequest
url String
Результат System.Net.HttpWebRequest

DefineCustomMenuGraphMLAttributes() защищенный Метод

protected DefineCustomMenuGraphMLAttributes ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Результат void

DefineImageFileGraphMLAttribute() защищенный Метод

protected DefineImageFileGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Результат void

DefineLabelGraphMLAttribute() защищенный Метод

protected DefineLabelGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Результат void

DefineRelationshipGraphMLAttribute() защищенный Метод

protected DefineRelationshipGraphMLAttribute ( GraphMLXmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
Результат void

ExceptionIsWebOrXml() защищенный Метод

protected ExceptionIsWebOrXml ( Exception oException ) : System.Boolean
oException System.Exception
Результат System.Boolean

ExceptionToMessage() публичный абстрактный Метод

public abstract ExceptionToMessage ( Exception oException ) : String
oException System.Exception
Результат String

FireProgressChanged() защищенный Метод

protected FireProgressChanged ( ProgressChangedEventArgs e ) : void
e System.ComponentModel.ProgressChangedEventArgs
Результат void

GetNeedToAppendVertices() защищенный Метод

protected GetNeedToAppendVertices ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
eNetworkLevel NetworkLevel
iRecursionLevel System.Int32
Результат System.Boolean

GetNeedToRecurse() защищенный Метод

protected GetNeedToRecurse ( NetworkLevel eNetworkLevel, Int32 iRecursionLevel ) : System.Boolean
eNetworkLevel NetworkLevel
iRecursionLevel System.Int32
Результат System.Boolean

GetXmlDocumentNoRetries() защищенный Метод

protected GetXmlDocumentNoRetries ( HttpWebRequest oHttpWebRequest ) : XmlDocument
oHttpWebRequest System.Net.HttpWebRequest
Результат System.Xml.XmlDocument

GetXmlDocumentWithRetries() защищенный Метод

protected GetXmlDocumentWithRetries ( String sUrl, HttpStatusCode aeHttpStatusCodesToFailImmediately, RequestStatistics oRequestStatistics ) : XmlDocument
sUrl String
aeHttpStatusCodesToFailImmediately HttpStatusCode
oRequestStatistics RequestStatistics
Результат System.Xml.XmlDocument

HttpNetworkAnalyzerBase() публичный Метод

Initializes a new instance of the class.
public HttpNetworkAnalyzerBase ( ) : System
Результат System

NetworkLevelToString() защищенный Метод

protected NetworkLevelToString ( NetworkLevel eNetworkLevel ) : String
eNetworkLevel NetworkLevel
Результат String

OnNetworkObtained() защищенный Метод

protected OnNetworkObtained ( XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription, String sNetworkTitle ) : void
oGraphMLXmlDocument System.Xml.XmlDocument
oRequestStatistics RequestStatistics
sNetworkDescription String
sNetworkTitle String
Результат void

OnNetworkObtainedWithoutTerminatingException() защищенный Метод

protected OnNetworkObtainedWithoutTerminatingException ( GraphMLXmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics, String sNetworkDescription ) : void
oGraphMLXmlDocument Smrf.XmlLib.GraphMLXmlDocument
oRequestStatistics RequestStatistics
sNetworkDescription String
Результат void

OnTerminatingException() защищенный Метод

protected OnTerminatingException ( Exception oException ) : void
oException System.Exception
Результат void

OnUnexpectedException() защищенный Метод

protected OnUnexpectedException ( Exception oException, XmlDocument oGraphMLXmlDocument, RequestStatistics oRequestStatistics ) : void
oException System.Exception
oGraphMLXmlDocument System.Xml.XmlDocument
oRequestStatistics RequestStatistics
Результат void

ReportProgress() защищенный Метод

protected ReportProgress ( String sProgressMessage ) : void
sProgressMessage String
Результат void

WebExceptionHasHttpStatusCode() защищенный Метод

protected WebExceptionHasHttpStatusCode ( WebException oWebException ) : System.Boolean
oWebException System.Net.WebException
Результат System.Boolean

Описание свойств

HttpRetryDelaysSec защищенное статическое свойство

protected static Int32[],System HttpRetryDelaysSec
Результат System.Int32[]

m_oBackgroundWorker защищенное свойство

protected BackgroundWorker,System.ComponentModel m_oBackgroundWorker
Результат System.ComponentModel.BackgroundWorker