luosheng/Modbus.Net
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean

Browse Source
This commit is contained in:
luosheng
2023-07-16 08:17:03 +08:00
parent 6d655b24d1
commit 2055c10c59
127 changed files with 7414 additions and 7470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Technosoftware/DaAeHdaClient/Interfaces/IOpcDiscovery.cs
View File

@@ -27,16 +27,16 @@ using System;
namespace Technosoftware.DaAeHdaClient
{
/// <summary>
/// This interface is used to discover OPC servers on the network.
/// </summary>
public interface IOpcDiscovery : IDisposable
{
/// <summary>
/// Returns a list of host names which could contain OPC servers.
/// </summary>
/// <returns>A array of strings that are valid network host names.</returns>
string[] EnumerateHosts();
/// <summary>
/// This interface is used to discover OPC servers on the network.
/// </summary>
public interface IOpcDiscovery : IDisposable
{
/// <summary>
/// Returns a list of host names which could contain OPC servers.
/// </summary>
/// <returns>A array of strings that are valid network host names.</returns>
string[] EnumerateHosts();
/// <summary>
/// Returns a list of servers that support an OPC specification.
@@ -53,5 +53,5 @@ namespace Technosoftware.DaAeHdaClient
/// <param name="connectData">Any necessary user authentication or protocol configuration information.</param>
/// <returns>An array of unconnected OPC server objects.</returns>
OpcServer[] GetAvailableServers(OpcSpecification specification, string host, OpcConnectData connectData);
}
}
}

112
Technosoftware/DaAeHdaClient/Interfaces/IOpcServer.cs
View File

@@ -26,69 +26,69 @@ using System;
namespace Technosoftware.DaAeHdaClient
{
/// <summary>
/// Defines functionality that is common to all OPC servers.
/// </summary>
public interface IOpcServer : IDisposable
{
/// <summary>
/// An event to receive server shutdown notifications. This event can be used by the
/// client so that the server can request that the client should disconnect from the
/// server.
/// </summary>
/// <remarks>
/// The OpcServerShutdownEvent event will be called when the server needs to
/// shutdown. The client should release all connections and interfaces for this
/// server.<br/>
/// A client which is connected to multiple OPCServers (for example Data access and/or
/// other servers such as Alarms and events servers from one or more vendors) should
/// maintain separate shutdown callbacks for each server since any server can shut down
/// independently of the others.
/// </remarks>
/// <summary>
/// Defines functionality that is common to all OPC servers.
/// </summary>
public interface IOpcServer : IDisposable
{
/// <summary>
/// An event to receive server shutdown notifications. This event can be used by the
/// client so that the server can request that the client should disconnect from the
/// server.
/// </summary>
/// <remarks>
/// The OpcServerShutdownEvent event will be called when the server needs to
/// shutdown. The client should release all connections and interfaces for this
/// server.<br/>
/// A client which is connected to multiple OPCServers (for example Data access and/or
/// other servers such as Alarms and events servers from one or more vendors) should
/// maintain separate shutdown callbacks for each server since any server can shut down
/// independently of the others.
/// </remarks>
event OpcServerShutdownEventHandler ServerShutdownEvent;
/// <summary>
/// The locale used in any error messages or results returned to the client.
/// </summary>
/// <returns>The locale name in the format "[languagecode]-[country/regioncode]".</returns>
string GetLocale();
/// <summary>
/// The locale used in any error messages or results returned to the client.
/// </summary>
/// <returns>The locale name in the format "[languagecode]-[country/regioncode]".</returns>
string GetLocale();
/// <summary>
/// Sets the locale used in any error messages or results returned to the client.
/// </summary>
/// <param name="locale">The locale name in the format "[languagecode]-[country/regioncode]".</param>
/// <returns>A locale that the server supports and is the best match for the requested locale.</returns>
string SetLocale(string locale);
/// <summary>
/// Sets the locale used in any error messages or results returned to the client.
/// </summary>
/// <param name="locale">The locale name in the format "[languagecode]-[country/regioncode]".</param>
/// <returns>A locale that the server supports and is the best match for the requested locale.</returns>
string SetLocale(string locale);
/// <summary>
/// Allows the client to optionally register a client name with the server. This is included primarily for debugging purposes. The recommended behavior is that the client set his Node name and EXE name here.
/// </summary>
void SetClientName(string clientName);
/// <summary>
/// Allows the client to optionally register a client name with the server. This is included primarily for debugging purposes. The recommended behavior is that the client set his Node name and EXE name here.
/// </summary>
void SetClientName(string clientName);
/// <summary>
/// Returns the locales supported by the server
/// </summary>
/// <remarks>The first element in the array must be the default locale for the server.</remarks>
/// <returns>An array of locales with the format "[languagecode]-[country/regioncode]".</returns>
string[] GetSupportedLocales();
/// <summary>
/// Returns the locales supported by the server
/// </summary>
/// <remarks>The first element in the array must be the default locale for the server.</remarks>
/// <returns>An array of locales with the format "[languagecode]-[country/regioncode]".</returns>
string[] GetSupportedLocales();
/// <summary>
/// Returns the localized text for the specified result code.
/// </summary>
/// <param name="locale">The locale name in the format "[languagecode]-[country/regioncode]".</param>
/// <param name="resultId">The result code identifier.</param>
/// <returns>A message localized for the best match for the requested locale.</returns>
string GetErrorText(string locale, OpcResult resultId);
/// <summary>
/// Returns the localized text for the specified result code.
/// </summary>
/// <param name="locale">The locale name in the format "[languagecode]-[country/regioncode]".</param>
/// <param name="resultId">The result code identifier.</param>
/// <returns>A message localized for the best match for the requested locale.</returns>
string GetErrorText(string locale, OpcResult resultId);
}
/// <summary>
/// A delegate to receive shutdown notifications from the server. This delegate can
/// be used by the client so that the server can request that the client should disconnect
/// from the server.
/// </summary>
/// <param name="reason">
/// A text string provided by the server indicating the reason for the shutdown. The
/// server may pass a null or empty string if no reason is provided.
/// </param>
/// <summary>
/// A delegate to receive shutdown notifications from the server. This delegate can
/// be used by the client so that the server can request that the client should disconnect
/// from the server.
/// </summary>
/// <param name="reason">
/// A text string provided by the server indicating the reason for the shutdown. The
/// server may pass a null or empty string if no reason is provided.
/// </param>
public delegate void OpcServerShutdownEventHandler(string reason);
}