pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-04-13 04:26:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: add XML documentation to PepperDash.Core project

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:48:23 +00:00
parent eeb0e84dc7
commit 260677a37f
59 changed files with 1072 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

36
src/PepperDash.Core/Comm/GenericSecureTcpIpClient.cs
View file

@ -81,6 +81,9 @@ namespace PepperDash.Core
/// <summary>
/// Port on server
/// </summary>
/// <summary>
/// Gets or sets the Port
/// </summary>
public int Port { get; set; }
/// <summary>
@ -151,6 +154,9 @@ namespace PepperDash.Core
/// <summary>
/// bool to track if auto reconnect should be set on the socket
/// </summary>
/// <summary>
/// Gets or sets the AutoReconnect
/// </summary>
public bool AutoReconnect { get; set; }
/// <summary>
@ -190,6 +196,9 @@ namespace PepperDash.Core
/// <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>
public bool SharedKeyRequired { get; set; }
/// <summary>
@ -209,6 +218,9 @@ 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>
public string SharedKey { get; set; }
/// <summary>
@ -224,6 +236,9 @@ namespace PepperDash.Core
/// <summary>
/// Bool showing if socket is ready for communication after shared key exchange
/// </summary>
/// <summary>
/// Gets or sets the IsReadyForCommunication
/// </summary>
public bool IsReadyForCommunication { get; set; }
/// <summary>
@ -344,6 +359,9 @@ namespace PepperDash.Core
/// <summary>
/// Just to help S+ set the key
/// </summary>
/// <summary>
/// Initialize method
/// </summary>
public void Initialize(string key)
{
Key = key;
@ -421,6 +439,9 @@ namespace PepperDash.Core
/// Deactivate the client
/// </summary>
/// <returns></returns>
/// <summary>
/// Deactivate method
/// </summary>
public override bool Deactivate()
{
if (_client != null)
@ -434,6 +455,9 @@ 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>
public void Connect()
{
ConnectionCount++;
@ -565,6 +589,9 @@ namespace PepperDash.Core
/// <summary>
///
/// </summary>
/// <summary>
/// Disconnect method
/// </summary>
public void Disconnect()
{
this.LogVerbose("Disconnect Called");
@ -588,6 +615,9 @@ namespace PepperDash.Core
/// <summary>
/// Does the actual disconnect business
/// </summary>
/// <summary>
/// DisconnectClient method
/// </summary>
public void DisconnectClient()
{
if (_client == null) return;
@ -848,6 +878,9 @@ namespace PepperDash.Core
/// <summary>
/// General send method
/// </summary>
/// <summary>
/// SendText method
/// </summary>
public void SendText(string text)
{
if (!string.IsNullOrEmpty(text))
@ -877,6 +910,9 @@ namespace PepperDash.Core
/// <summary>
///
/// </summary>
/// <summary>
/// SendBytes method
/// </summary>
public void SendBytes(byte[] bytes)
{
if (bytes.Length > 0)