docs: add XML documentation to PepperDash.Core project

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:48:23 +00:00
parent eeb0e84dc7
commit 260677a37f
59 changed files with 1072 additions and 5 deletions

View File

@@ -60,6 +60,9 @@ namespace PepperDash.Core
/// <summary>
///
/// </summary>
/// <summary>
/// Delegate for ServerHasChokedCallbackDelegate
/// </summary>
public delegate void ServerHasChokedCallbackDelegate();
#endregion
@@ -106,6 +109,9 @@ namespace PepperDash.Core
/// <summary>
/// 3 by default
/// </summary>
/// <summary>
/// Gets or sets the MonitorClientMaxFailureCount
/// </summary>
public int MonitorClientMaxFailureCount { get; set; }
/// <summary>
@@ -192,6 +198,9 @@ namespace PepperDash.Core
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
public int Port { get; set; }
/// <summary>
@@ -226,6 +235,9 @@ namespace PepperDash.Core
/// SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module.
/// If SharedKey changes while server is listening or clients are connected, disconnect and stop listening will be called
/// </summary>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
public string SharedKey { get; set; }
/// <summary>
@@ -250,6 +262,9 @@ namespace PepperDash.Core
/// <summary>
/// Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatRequiredIntervalMs
/// </summary>
public int HeartbeatRequiredIntervalMs { get; set; }
/// <summary>
@@ -260,6 +275,9 @@ namespace PepperDash.Core
/// <summary>
/// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatStringToMatch
/// </summary>
public string HeartbeatStringToMatch { get; set; }
//private timers for Heartbeats per client
@@ -278,6 +296,9 @@ namespace PepperDash.Core
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
public int BufferSize { get; set; }
/// <summary>
@@ -341,6 +362,9 @@ namespace PepperDash.Core
/// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method
/// </summary>
public void KillServer()
{
ServerStopped = true;
@@ -356,6 +380,9 @@ namespace PepperDash.Core
/// Initialize Key for device using client name from SIMPL+. Called on Listen from SIMPL+
/// </summary>
/// <param name="key"></param>
/// <summary>
/// Initialize method
/// </summary>
public void Initialize(string key)
{
Key = key;
@@ -397,6 +424,9 @@ namespace PepperDash.Core
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary>
/// Listen method
/// </summary>
public void Listen()
{
ServerCCSection.Enter();
@@ -455,6 +485,9 @@ namespace PepperDash.Core
/// <summary>
/// Stop Listeneing
/// </summary>
/// <summary>
/// StopListening method
/// </summary>
public void StopListening()
{
try
@@ -478,6 +511,9 @@ namespace PepperDash.Core
/// Disconnects Client
/// </summary>
/// <param name="client"></param>
/// <summary>
/// DisconnectClient method
/// </summary>
public void DisconnectClient(uint client)
{
try
@@ -493,6 +529,9 @@ namespace PepperDash.Core
/// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method
/// </summary>
public void DisconnectAllClientsForShutdown()
{
Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "Disconnecting All Clients");
@@ -533,6 +572,9 @@ namespace PepperDash.Core
/// Broadcast text from server to all connected clients
/// </summary>
/// <param name="text"></param>
/// <summary>
/// BroadcastText method
/// </summary>
public void BroadcastText(string text)
{
CCriticalSection CCBroadcast = new CCriticalSection();
@@ -566,6 +608,9 @@ namespace PepperDash.Core
/// </summary>
/// <param name="text"></param>
/// <param name="clientIndex"></param>
/// <summary>
/// SendTextToClient method
/// </summary>
public void SendTextToClient(string text, uint clientIndex)
{
try
@@ -634,6 +679,9 @@ namespace PepperDash.Core
/// </summary>
/// <param name="clientIndex"></param>
/// <returns></returns>
/// <summary>
/// GetClientIPAddress method
/// </summary>
public string GetClientIPAddress(uint clientIndex)
{
Debug.Console(1, this, Debug.ErrorLogLevel.Notice, "GetClientIPAddress Index: {0}", clientIndex);