XMLDA.NET Reference
OpcXmlDA Class Members
See Also  Fields  Properties  Methods  Send Feedback
xmldanet.xmlda Namespace : OpcXmlDA Class


Glossary Item Box

The following tables list the members exposed by OpcXmlDA.

Public Constructors

 NameDescription
Public ConstructorOpcXmlDA Constructor  
Top

Public Fields

 NameDescription
Public FieldRingBufferSize Subscription ring-buffer size in the internal OPC-DA gateway.  
Public FieldUrl URL of the XML-DA serverice or ProgID of the OPC-DA server.  
Top

Public Properties

 NameDescription
Public PropertyCredentials Credentials for the server access  
Public Propertystatic (Shared in Visual Basic)EndPointConfigurationGet the Endpoints defined in the WCF Application Configuration.
This static property exists only in the XmlDaNetWCF.DLL.  
Public PropertyEndPointNameWCF endpoint to be used in the server access. The name must be defiend in the WCF Configuration. The default value is "basicHTTP".
This property exists only in the XmlDaNetWCF.DLL  
Public PropertyOpcDaDisconnectIdleTime Idle time in seconds. The OPC-DA server is disconnected when there is no client acivity for this time. The default is 20 seconds. This property is used only for OPC-DA server access.  
Public PropertyOpcDaReadFromDevice Force all reads made from the device  
Public PropertyOpcDaWaitAfterAddItems Delay in milliseconds after AddItems to an OPC server group. Some servers need time before a read/write operation can be executed.  
Public PropertyOpcDaWaitAfterConnect Delay in milliseconds after a connect to an OPC DA server. Somer servers need time to be ready for client calls.  
Public PropertyProxy Proxy access for the Web access  
Public PropertyReadWriteTimeout Read/Write timeout in ms  
Public PropertyTimeout Client wait timeout in ms  
Public PropertyUserAgent User agent header sent with each request  
Top

Public Methods

 NameDescription
Public MethodBeginBrowse XML-DA method to asynchronously browse an XML-DA or OPC-DA server.  
Public MethodBeginGetProperties XML-DA method to asynchronously get item properties from an XML-DA or OPC-DA server.  
Public MethodBeginGetStatusXML-DA method to asynchronously read the current XML-DA or OPC-DA server status.
The purpose of the GetStatus service is:
- It provides a common mechanism for checking the status of the server - whether it is operational or in need of maintenance.
- It provides a common mechanism for obtaining vendor-specific information about the server that is not available through the other OPC services (version number, etc).
- Provides insight for clients as to the relative time synchronization between the client and server. As an example, this information is useful for Read requests.  
Public MethodBeginRead XML-DA method to asynchronously read a set of item values from an XML-DA or OPC-DA server.  
Public MethodBeginSubscribe XML-DA method to asynchronously subscribe a set of item values with either an XML-DA or OPC-DA server.  
Public MethodBeginSubscriptionCancel XML-DA method to asynchronously cancel a subscription with either an XML-DA or OPC-DA server.  
Public MethodBeginSubscriptionPolledRefresh XML-DA method to asynchronously poll subscribed items from either an XML-DA or OPC-DA server.  
Public MethodBeginWrite XML-DA method to asynchronously write a set of item values to either an XML-DA or OPC-DA server.  
Public MethodBrowse XML-DA method to browse an XML-DA or OPC-DA server.  
Public MethodDispose  
Public MethodEndBrowse XML-DA method to asynchronously browse an XML-DA or OPC-DA server.  
Public MethodEndGetProperties XML-DA method to asynchronously get item properties from an XML-DA or OPC-DA server.  
Public MethodEndGetStatusXML-DA method to asynchronously read the current XML-DA or OPC-DA server status.
The purpose of the GetStatus service is:
- It provides a common mechanism for checking the status of the server - whether it is operational or in need of maintenance.
- It provides a common mechanism for obtaining vendor-specific information about the server that is not available through the other OPC services (version number, etc).
- Provides insight for clients as to the relative time synchronization between the client and server. As an example, this information is useful for Read requests.  
Public MethodEndRead XML-DA method to asynchronously read a set of item values from an XML-DA or OPC-DA server.  
Public MethodEndSubscribe XML-DA method to asynchronously subscribe a set of item values with either an XML-DA or OPC-DA server.  
Public MethodEndSubscriptionCancel XML-DA method to asynchronously cancel a subscription with either an XML-DA or OPC-DA server.  
Public MethodEndSubscriptionPolledRefresh XML-DA method to asynchronously poll subscribed items from either an XML-DA or OPC-DA server.  
Public MethodEndWrite XML-DA method to asynchronously write a set of item values to either an XML-DA or OPC-DA server.  
Public MethodGetProperties XML-DA method to get item properties for a set of items from an XML-DA or OPC-DA server.  
Public MethodGetStatusXML-DA method to get the current XML-DA or OPC-DA server status.
The purpose of the GetStatus service is:
- It provides a common mechanism for checking the status of the server - whether it is operational or in need of maintenance.
- It provides a common mechanism for obtaining vendor-specific information about the server that is not available through the other OPC services (version number, etc).
- Provides insight for clients as to the relative time synchronization between the client and server. As an example, this information is useful for Read requests.  
Public MethodRead XML-DA method to read a set of item values from an XML-DA or OPC-DA server.  
Public MethodSubscribe XML-DA method to subscribe a set of item values with either an XML-DA or OPC-DA server.  
Public MethodSubscriptionCancel XML-DA method to cancel a subscription with either an XML-DA or OPC-DA server.  
Public MethodSubscriptionPolledRefresh XML-DA method to poll subscribed items from either an XML-DA or OPC-DA server.  
Public MethodWrite XML-DA method to write a set of item values to either an XML-DA or OPC-DA server.  
Top

See Also

© 2002-2012 Advosol Inc. All Rights Reserved.