pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-12 19:24:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse Source 
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:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/PepperDash.Core/Comm/CommunicationGather.cs
View File

@@ -84,10 +84,6 @@ namespace PepperDash.Core
port.TextReceived += Port_TextReceivedStringDelimiter;
}
/// <summary>
/// Disconnects this gather from the Port's TextReceived event. This will not fire LineReceived
/// after the this call.
/// </summary>
/// <summary>
/// Stop method
/// </summary>

6
src/PepperDash.Core/Comm/CommunicationStreamDebugging.cs
View File

@@ -22,9 +22,6 @@ namespace PepperDash.Core
/// </summary>
private CTimer DebugExpiryPeriod;
/// <summary>
/// The current debug setting
/// </summary>
/// <summary>
/// Gets or sets the DebugSetting
/// </summary>
@@ -44,9 +41,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Indicates that receive stream debugging is enabled
/// </summary>
/// <summary>
/// Gets or sets the RxStreamDebuggingIsEnabled
/// </summary>

3
src/PepperDash.Core/Comm/ControlPropertiesConfig.cs
View File

@@ -5,9 +5,6 @@ using Newtonsoft.Json.Converters;
namespace PepperDash.Core
{
/// <summary>
/// Config properties that indicate how to communicate with a device for control
/// </summary>
/// <summary>
/// Represents a ControlPropertiesConfig
/// </summary>

9
src/PepperDash.Core/Comm/EventArgs.cs
View File

@@ -29,9 +29,6 @@ namespace PepperDash.Core
/// </summary>
public class GenericSocketStatusChageEventArgs : EventArgs
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Client
/// </summary>
@@ -62,9 +59,6 @@ namespace PepperDash.Core
/// </summary>
public class GenericTcpServerStateChangedEventArgs : EventArgs
{
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the State
/// </summary>
@@ -159,9 +153,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Gets or sets the Text
/// </summary>

33
src/PepperDash.Core/Comm/GenericSecureTcpIpClient.cs
View File

@@ -78,9 +78,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -151,9 +148,6 @@ namespace PepperDash.Core
/// </summary>
public string ConnectionFailure { get { return ClientStatus.ToString(); } }
/// <summary>
/// bool to track if auto reconnect should be set on the socket
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
@@ -193,9 +187,6 @@ namespace PepperDash.Core
#region GenericSecureTcpIpClient properties
/// <summary>
/// Bool to show whether the server requires a preshared key. This is used in the DynamicTCPServer class
/// </summary>
/// <summary>
/// Gets or sets the SharedKeyRequired
/// </summary>
@@ -215,9 +206,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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
/// </summary>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -233,9 +221,6 @@ namespace PepperDash.Core
/// </summary>
bool IsTryingToConnect;
/// <summary>
/// Bool showing if socket is ready for communication after shared key exchange
/// </summary>
/// <summary>
/// Gets or sets the IsReadyForCommunication
/// </summary>
@@ -356,9 +341,6 @@ namespace PepperDash.Core
BufferSize = 2000;
}
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -452,9 +434,6 @@ namespace PepperDash.Core
return true;
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -586,9 +565,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -612,9 +588,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Does the actual disconnect business
/// </summary>
/// <summary>
/// DisconnectClient method
/// </summary>
@@ -875,9 +848,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -907,9 +877,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

24
src/PepperDash.Core/Comm/GenericSecureTcpIpClient_ForServer.cs
View File

@@ -79,9 +79,6 @@ namespace PepperDash.Core
/// </summary>
public string Hostname { get; set; }
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -115,9 +112,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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
/// </summary>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -128,9 +122,6 @@ namespace PepperDash.Core
/// </summary>
private bool WaitingForSharedKeyResponse { get; set; }
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -344,9 +335,6 @@ namespace PepperDash.Core
#region Methods
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -406,9 +394,6 @@ namespace PepperDash.Core
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -540,9 +525,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -821,9 +803,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -853,9 +832,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

34
src/PepperDash.Core/Comm/GenericSecureTcpIpServer.cs
View File

@@ -57,9 +57,6 @@ namespace PepperDash.Core
/// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary>
/// Delegate for ServerHasChokedCallbackDelegate
/// </summary>
@@ -106,9 +103,6 @@ namespace PepperDash.Core
/// </summary>
int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary>
/// Gets or sets the MonitorClientMaxFailureCount
/// </summary>
@@ -195,9 +189,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -231,10 +222,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
@@ -259,9 +246,6 @@ 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>
@@ -272,9 +256,6 @@ namespace PepperDash.Core
/// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
/// <summary>
/// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatStringToMatch
/// </summary>
@@ -293,9 +274,6 @@ namespace PepperDash.Core
/// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -360,9 +338,6 @@ namespace PepperDash.Core
#region Methods - Server Actions
/// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method
/// </summary>
public void KillServer()
@@ -421,9 +396,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary>
/// Listen method
/// </summary>
@@ -482,9 +454,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Stop Listeneing
/// </summary>
/// <summary>
/// StopListening method
/// </summary>
@@ -527,9 +496,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method
/// </summary>
public void DisconnectAllClientsForShutdown()

31
src/PepperDash.Core/Comm/GenericSshClient.cs
View File

@@ -41,9 +41,6 @@ namespace PepperDash.Core
///// </summary>
//public event GenericSocketStatusChangeEventDelegate SocketStatusChange;
/// <summary>
/// Address of server
/// </summary>
/// <summary>
/// Gets or sets the Hostname
/// </summary>
@@ -54,17 +51,11 @@ namespace PepperDash.Core
/// </summary>
public int Port { get; set; }
/// <summary>
/// Username for server
/// </summary>
/// <summary>
/// Gets or sets the Username
/// </summary>
public string Username { get; set; }
/// <summary>
/// And... Password for server. That was worth documenting!
/// </summary>
/// <summary>
/// Gets or sets the Password
/// </summary>
@@ -131,10 +122,6 @@ namespace PepperDash.Core
set { AutoReconnect = value == 1; }
}
/// <summary>
/// Millisecond value, determines the timeout period in between reconnect attempts.
/// Set to 5000 by default
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnectIntervalMs
/// </summary>
@@ -209,9 +196,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Connect to the server, using the provided properties.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -339,9 +323,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect the clients and put away it's resources.
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -573,9 +554,6 @@ namespace PepperDash.Core
//*****************************************************************************************************
//*****************************************************************************************************
/// <summary>
/// Fired when connection changes
/// </summary>
/// <summary>
/// Represents a SshConnectionChangeEventArgs
/// </summary>
public class SshConnectionChangeEventArgs : EventArgs
@@ -585,25 +563,16 @@ public class SshConnectionChangeEventArgs : EventArgs
/// </summary>
public bool IsConnected { get; private set; }
/// <summary>
/// Connection Status represented as a ushort
/// </summary>
/// <summary>
/// Gets or sets the UIsConnected
/// </summary>
public ushort UIsConnected { get { return (ushort)(Client.IsConnected ? 1 : 0); } }
/// <summary>
/// The client
/// </summary>
/// <summary>
/// Gets or sets the Client
/// </summary>
public GenericSshClient Client { get; private set; }
/// <summary>
/// Socket Status as represented by
/// </summary>
/// <summary>
/// Gets or sets the Status
/// </summary>

36
src/PepperDash.Core/Comm/GenericTcpIpClient.cs
View File

@@ -58,9 +58,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -138,9 +135,6 @@ namespace PepperDash.Core
/// </summary>
public string ConnectionFailure { get { return ClientStatus.ToString(); } }
/// <summary>
/// bool to track if auto reconnect should be set on the socket
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
@@ -237,9 +231,6 @@ namespace PepperDash.Core
}, Timeout.Infinite);
}
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -279,9 +270,6 @@ namespace PepperDash.Core
return true;
}
/// <summary>
/// Attempts to connect to the server
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -349,9 +337,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Attempts to disconnect the client
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -372,9 +357,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Does the actual disconnect business
/// </summary>
/// <summary>
/// DisconnectClient method
/// </summary>
@@ -467,9 +449,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -483,9 +462,6 @@ namespace PepperDash.Core
_client.SendData(bytes, bytes.Length);
}
/// <summary>
/// This is useful from console and...?
/// </summary>
/// <summary>
/// SendEscapedText method
/// </summary>
@@ -538,9 +514,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Configuration properties for TCP/SSH Connections
/// </summary>
/// <summary>
/// Represents a TcpSshPropertiesConfig
/// </summary>
@@ -562,9 +535,6 @@ namespace PepperDash.Core
/// Username credential
/// </summary>
public string Username { get; set; }
/// <summary>
/// Passord credential
/// </summary>
/// <summary>
/// Gets or sets the Password
/// </summary>
@@ -575,17 +545,11 @@ namespace PepperDash.Core
/// </summary>
public int BufferSize { get; set; }
/// <summary>
/// Defaults to true
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
public bool AutoReconnect { get; set; }
/// <summary>
/// Defaults to 5000ms
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnectIntervalMs
/// </summary>

24
src/PepperDash.Core/Comm/GenericTcpIpClient_ForServer.cs
View File

@@ -68,9 +68,6 @@ namespace PepperDash.Core
/// </summary>
public string Hostname { get; set; }
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -104,9 +101,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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
/// </summary>
/// <summary>
/// Gets or sets the SharedKey
/// </summary>
@@ -117,9 +111,6 @@ namespace PepperDash.Core
/// </summary>
private bool WaitingForSharedKeyResponse { get; set; }
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -297,9 +288,6 @@ namespace PepperDash.Core
#region Methods
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
@@ -322,9 +310,6 @@ namespace PepperDash.Core
}
/// <summary>
/// Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -456,9 +441,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -686,9 +668,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
@@ -718,9 +697,6 @@ namespace PepperDash.Core
}
}
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>

34
src/PepperDash.Core/Comm/GenericTcpIpServer.cs
View File

@@ -51,9 +51,6 @@ namespace PepperDash.Core
/// </summary>
public ServerHasChokedCallbackDelegate ServerHasChoked { get; set; }
/// <summary>
///
/// </summary>
/// <summary>
/// Delegate for ServerHasChokedCallbackDelegate
/// </summary>
@@ -84,9 +81,6 @@ namespace PepperDash.Core
/// </summary>
int MonitorClientFailureCount;
/// <summary>
/// 3 by default
/// </summary>
/// <summary>
/// Gets or sets the MonitorClientMaxFailureCount
/// </summary>
@@ -176,9 +170,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Port Server should listen on
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
@@ -212,10 +203,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// 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>
@@ -240,9 +227,6 @@ 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>
@@ -253,9 +237,6 @@ namespace PepperDash.Core
/// </summary>
public ushort HeartbeatRequiredIntervalInSeconds { set { HeartbeatRequiredIntervalMs = (value * 1000); } }
/// <summary>
/// String to Match for heartbeat. If null or empty any string will reset heartbeat timer
/// </summary>
/// <summary>
/// Gets or sets the HeartbeatStringToMatch
/// </summary>
@@ -274,9 +255,6 @@ namespace PepperDash.Core
/// </summary>
public List<uint> ConnectedClientsIndexes = new List<uint>();
/// <summary>
/// Defaults to 2000
/// </summary>
/// <summary>
/// Gets or sets the BufferSize
/// </summary>
@@ -341,9 +319,6 @@ namespace PepperDash.Core
#region Methods - Server Actions
/// <summary>
/// Disconnects all clients and stops the server
/// </summary>
/// <summary>
/// KillServer method
/// </summary>
public void KillServer()
@@ -401,9 +376,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Start listening on the specified port
/// </summary>
/// <summary>
/// Listen method
/// </summary>
@@ -461,9 +433,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Stop Listening
/// </summary>
/// <summary>
/// StopListening method
/// </summary>
@@ -506,9 +475,6 @@ namespace PepperDash.Core
}
}
/// <summary>
/// Disconnect All Clients
/// </summary>
/// <summary>
/// DisconnectAllClientsForShutdown method
/// </summary>
public void DisconnectAllClientsForShutdown()

9
src/PepperDash.Core/Comm/GenericUdpServer.cs
View File

@@ -187,9 +187,6 @@ namespace PepperDash.Core
Disconnect();
}
/// <summary>
/// Enables the UDP Server
/// </summary>
/// <summary>
/// Connect method
/// </summary>
@@ -227,9 +224,6 @@ namespace PepperDash.Core
Server.ReceiveDataAsync(Receive);
}
/// <summary>
/// Disabled the UDP Server
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
@@ -335,9 +329,6 @@ namespace PepperDash.Core
}
/// <summary>
///
/// </summary>
/// <summary>
/// Represents a GenericUdpReceiveTextExtraArgs
/// </summary>

3
src/PepperDash.Core/Comm/TcpClientConfigObject.cs
View File

@@ -2,9 +2,6 @@
namespace PepperDash.Core
{
/// <summary>
/// Client config object for TCP client with server that inherits from TcpSshPropertiesConfig and adds properties for shared key and heartbeat
/// </summary>
/// <summary>
/// Represents a TcpClientConfigObject
/// </summary>