Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / ConnectionProperties Class
Properties


In This Topic
    ConnectionProperties Class Members
    In This Topic

    The following tables list the members exposed by ConnectionProperties.

    Public Constructors
     NameDescription
    Public ConstructorConnectionProperties Constructor Constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyCloseTimeout Maximum amount of time to close a connection before timing out. Default value is 1 minute.  
    Public PropertyInactivityTimeout Maximum amount of time before an inactive connection will time out. Default value is 10 minutes.  
    Public PropertyMaxItemsInObjectGraph The maximum number of objects (including array elements) to serialize or deserialize. Default value is 1M.  
    Public PropertyMaxReceivedMessageSize Maximum size for a received message in bytes. Default is 1M.  
    Public PropertyOpenTimeout Maximum amount of time to attempt to open a connection before timing out. Default value is 1 minute.  
    Public PropertyPassword A matching user password.  
    Public PropertyReceiveTimeout Maximum amount of time to receive before timing out. Default value is 1 minute.  
    Public PropertyReliableSessionEnabled Whether to enable reliable sessions. Default value is false.  
    Public PropertySendTimeout Maximum amount of time to send a request before timing out. Default value is 1 minute.  
    Public PropertyServerCertificateValidationModeA method of validating a security certificate on a Historian server.

    Default is CertificateValidationMode.ChainTrust, a certificate is considered valid if the chain builds to certification authority in the trusted root store.

    Use CertificateValidationMode.None, to connect to a Historian server secured by a self-signed certificate (out-of-the-box configuration).

     
    Public PropertyServerHostNameA fully qualified host name of a Historian server. Due to security identity checks, it is not possible to connect simply via server IP address.

    Default is local server if unspecified.

     
    Public PropertyUsername A name of a user account with access to the server. If unset the current Windows user is used for authentication.  
    Public PropertyXmlReaderQuotaMaxArrayLength Maximum array length returned by the reader. Default value is 1M.  
    Public PropertyXmlReaderQuotaMaxBytesPerRead Maximum bytes consumed by the reader at one time. Default values is 4K.  
    Public PropertyXmlReaderQuotaMaxDepth Maximum nested XML node depth. Limits the XML nested node depth. Default value is 32.  
    Public PropertyXmlReaderQuotaMaxNameTableCharCount Maximum size of character data in a reader's NameTable. Default value is 16K.  
    Public PropertyXmlReaderQuotaMaxStringContentLength Maximum length of a string returned by the reader. Default values is 8K.  
    Top
    See Also

    Reference

    ConnectionProperties Class
    Proficy.Historian.ClientAccess.API Namespace