lmxopcua/src/ZB.MOM.WW.OtOpcUa.Host/Domain/IMxProxy.cs

using ArchestrA.MxAccess;

namespace ZB.MOM.WW.OtOpcUa.Host.Domain
{
    /// <summary>
    ///     Delegate matching LMXProxyServer.OnDataChange COM event signature.
    /// </summary>
    /// <param name="hLMXServerHandle">The runtime connection handle that raised the change.</param>
    /// <param name="phItemHandle">The runtime item handle for the attribute that changed.</param>
    /// <param name="pvItemValue">The new raw runtime value for the attribute.</param>
    /// <param name="pwItemQuality">The OPC DA quality code supplied by the runtime.</param>
    /// <param name="pftItemTimeStamp">The timestamp object supplied by the runtime for the value.</param>
    /// <param name="ItemStatus">The MXAccess status payload associated with the callback.</param>
    public delegate void MxDataChangeHandler(
        int hLMXServerHandle,
        int phItemHandle,
        object pvItemValue,
        int pwItemQuality,
        object pftItemTimeStamp,
        ref MXSTATUS_PROXY[] ItemStatus);

    /// <summary>
    ///     Delegate matching LMXProxyServer.OnWriteComplete COM event signature.
    /// </summary>
    /// <param name="hLMXServerHandle">The runtime connection handle that processed the write.</param>
    /// <param name="phItemHandle">The runtime item handle that was written.</param>
    /// <param name="ItemStatus">The MXAccess status payload describing the write outcome.</param>
    public delegate void MxWriteCompleteHandler(
        int hLMXServerHandle,
        int phItemHandle,
        ref MXSTATUS_PROXY[] ItemStatus);

    /// <summary>
    ///     Abstraction over LMXProxyServer COM object to enable testing without the COM runtime. (MXA-001)
    /// </summary>
    public interface IMxProxy
    {
        /// <summary>
        ///     Registers the bridge as an MXAccess client with the runtime proxy.
        /// </summary>
        /// <param name="clientName">The client identity reported to the runtime for diagnostics and session tracking.</param>
        /// <returns>The runtime connection handle assigned to the client session.</returns>
        int Register(string clientName);

        /// <summary>
        ///     Unregisters the bridge from the runtime proxy and releases the connection handle.
        /// </summary>
        /// <param name="handle">The connection handle returned by <see cref="Register(string)" />.</param>
        void Unregister(int handle);

        /// <summary>
        ///     Adds a Galaxy attribute reference to the active runtime session.
        /// </summary>
        /// <param name="handle">The runtime connection handle.</param>
        /// <param name="address">The fully qualified attribute reference to resolve.</param>
        /// <returns>The runtime item handle assigned to the attribute.</returns>
        int AddItem(int handle, string address);

        /// <summary>
        ///     Removes a previously registered attribute from the runtime session.
        /// </summary>
        /// <param name="handle">The runtime connection handle.</param>
        /// <param name="itemHandle">The item handle returned by <see cref="AddItem(int, string)" />.</param>
        void RemoveItem(int handle, int itemHandle);

        /// <summary>
        ///     Starts supervisory updates for an attribute so runtime changes are pushed to the bridge.
        /// </summary>
        /// <param name="handle">The runtime connection handle.</param>
        /// <param name="itemHandle">The item handle to monitor.</param>
        void AdviseSupervisory(int handle, int itemHandle);

        /// <summary>
        ///     Stops supervisory updates for an attribute.
        /// </summary>
        /// <param name="handle">The runtime connection handle.</param>
        /// <param name="itemHandle">The item handle to stop monitoring.</param>
        void UnAdviseSupervisory(int handle, int itemHandle);

        /// <summary>
        ///     Writes a new value to a runtime attribute through the COM proxy.
        /// </summary>
        /// <param name="handle">The runtime connection handle.</param>
        /// <param name="itemHandle">The item handle to write.</param>
        /// <param name="value">The new value to push into the runtime.</param>
        /// <param name="securityClassification">The Wonderware security classification applied to the write.</param>
        void Write(int handle, int itemHandle, object value, int securityClassification);

        /// <summary>
        ///     Occurs when the runtime pushes a data-change callback for a subscribed attribute.
        /// </summary>
        event MxDataChangeHandler? OnDataChange;

        /// <summary>
        ///     Occurs when the runtime acknowledges completion of a write request.
        /// </summary>
        event MxWriteCompleteHandler? OnWriteComplete;
    }
}