Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / ServerConnection Class
Properties Methods Events


In This Topic
    ServerConnection Class Members
    In This Topic

    The following tables list the members exposed by ServerConnection.

    Public Constructors
     NameDescription
    Public Constructor Constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyThis instance's IArchives interface.  
    Public PropertyThis instance's ICollectors interface.  
    Public PropertyThis instance's IData interface.  
    Public PropertyThis instance's IDataStores interface.  
    Public PropertyThis instance's IEnumeratedSets interface.  
    Public PropertyThis instance's IMessages interface.  
    Public PropertyThis instance's IPublish interface.  
    Public PropertyThis instance's IQueryModifiers interface.  
    Public PropertyThis instance's IServer interface.  
    Public PropertyThis instance's ITags interface.  
    Public PropertyThis instance's IUserDefinedTypes interface.  
    Top
    Public Methods
     NameDescription
    Public Method Attempt to connect to a Historian server with credentials established in the constructor.  
    Public Method Disconnect from a Historian server.  
    Public Method Disconnects an establish connection.  
    Public Method Whether currently connected to a Historian server.  
    Public Method Invoked by the remote server to transmit archive subscription details.  
    Public Method Invoked by the remote server to transmit tag browse information. Large browse requests may generate multiple individual responses. Not all collectors support tag browsing.  
    Public Method Invoked by the remote server to transmit collector subscription details.  
    Public Method Invoked by the remote server to transmit the result of a control request.  
    Public Method Invoked by the remote server to transmit current collector tag values. Requesting many current values may generate multiple individual responses.  
    Public Method Invoked by the remote server to transmit hierarchical tag browse information. Large hierarchical browse requests may generate multiple individual responses. Not all collectors support hierarchical tag browsing.  
    Public Method Invoked by the remote server to transmit data subscription details.  
    Public Method Invoked by the remote server to transmit enumerated set subscription details.  
    Public Method Invoked by the remote server to transmit message subscription details.  
    Public Method Invoked by the remote server to transmit the result of adding a tag to being published.  
    Public Method Invoked by the remote server to transmit the requested destination server name.  
    Public Method Invoked by the remote server to transmit a list of published tags.  
    Public Method Invoked by the remote server to transmit the result of removing a tag from being published.  
    Public Method Invoked by the remote server to transmit the result of setting a destination server name.  
    Public Method Invoked by the remote server to transmit the result of setting published tag properties.  
    Public Method Invoked by the remote server to transmit tag subscription details.  
    Top
    Protected Methods
     NameDescription
    Protected Method Invoked when the connection object completes transition from the closing to closed states.  
    Protected Method Invoked when the connection object first enters the closing states.  
    Protected Method Invoked when the connection object first enters the faulted states.  
    Protected Method Invoked when the connection object first enters the opening states.  
    Protected Method Invoked when the connection object completes transition from the opening to opened states.  
    Top
    Public Events
     NameDescription
    Public Event Occurs in response to archive subscriptions when an archive has been added, deleted or modified.  
    Public Event Occurs when a connection has been terminated with a Historian server.  
    Public Event Occurs when a connection is being terminated with a Historian server.  
    Public Event Occurs when a collector responds with tag browse information.  
    Public Event Occurs in response to collector subscriptions when a collector has been added, deleted or modified.  
    Public Event Occurs when a collector responds to a control request, i.e. start or stop.  
    Public Event Occurs when a collector responds with current tag values.  
    Public Event Occurs when a collector responds with hierarchical tag browse information.  
    Public Event Occurs in response to data subscriptions when the latest tag value has been updated.  
    Public Event Occurs in response to enumerated set subscriptions when a set has been added, deleted, modified or renamed.  
    Public Event Occurs when a connection initially enters the faulted state.  
    Public Event Occurs in response to message subscriptions when a new message has been generated.  
    Public Event Occurs when a connection has been established with a Historian server.  
    Public Event Occurs when a connection is being established with a Historian server.  
    Public Event Occurs when a collector responds to adding a tag for publishing.  
    Public Event Occurs when a collector responds with the destination server name.  
    Public Event Occurs when a collector responds with published tag information.  
    Public Event Occurs when a collector responds to removing a tag from publishing.  
    Public Event Occurs when a collector responds to setting a destination server name.  
    Public Event Occurs when a collector responds to setting published tag properties.  
    Public Event Occurs in response to tag subscriptions when a tag has been added, deleted, modified or renamed.  
    Top
    See Also