- DocFx setup

- Improvements to naming convention
- Added NetworkTasks

Author: realChrisDeBon

P2PBootstrap/Program.cs

@@ -1,5 +1,5 @@
 global using static P2PNet.PeerNetwork;
-global using static P2PNet.Distribution.Distribution_Protocol;
+global using static P2PNet.Distribution.DistributionProtocol;
 global using static ConsoleDebugger.ConsoleDebugger;
 global using static P2PBootstrap.GlobalConfig;
 global using static P2PBootstrap.Database.DatabaseService;
@@ -9,7 +9,6 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Configuration;
 using P2PNet;
-using P2PNet.Distribution;
 using P2PNet.NetworkPackets;
 using P2PNet.Peers;
 using System.Text.Json.Serialization;
@@ -24,6 +23,7 @@
 using Microsoft.Extensions.FileProviders;
 using ConsoleDebugger;
 using P2PBootstrap.Encryption;
+using P2PNet.Distribution.NetworkTasks;
 
 namespace P2PBootstrap
 {

P2PBootstrap/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "xterm": "^5.3.0"
+  }
+}

P2PNet/DicoveryChannels/Discovery_Channel_Base.cs

@@ -9,7 +9,7 @@
 using System.Net.Sockets;
 using System.Text;
 using System.Threading.Tasks;
-using static P2PNet.Distribution.Distribution_Protocol;
+using static P2PNet.Distribution.DistributionProtocol;
 using static P2PNet.Distribution.DistributionHandler;
 using static P2PNet.PeerNetwork;
 

P2PNet/Distribution/Distribution_Protocol.cs

@@ -1,4 +1,5 @@
-using P2PNet.NetworkPackets;
+using P2PNet.Distribution.NetworkTasks;
+using P2PNet.NetworkPackets;
 using P2PNet.Peers;
 using System;
 using System.Collections.Generic;
@@ -12,10 +13,10 @@
 namespace P2PNet.Distribution
     {
     /// <summary>
-    /// The Distribution_Protocol provides uniformity with data exchange, packet formatting, and other functions within the peer-to-peer network.
+    /// The DistributionProtocol provides uniformity with data exchange, packet formatting, and other functions within the peer-to-peer network.
     /// This should be included as a static reference.
     /// </summary>
-    public static class Distribution_Protocol
+    public static class DistributionProtocol
         {
         public struct MessageTags
             {
@@ -198,112 +199,9 @@ public static T Deserialize<T>(string json)
         #endregion
         }
 
-    #region Tasks
-
-    /// <summary>
-    /// Defines the types of tasks that can be executed within the peer-to-peer network.
-    /// </summary>
-    public enum TaskType
-        {
-            /// <summary>
-            /// Block a peer and removes it from the network.
-            /// </summary>
-            BlockAndRemovePeer,
-
-            /// <summary>
-            /// Block a specific IP address from connecting to the network.
-            /// </summary>
-            BlockIP,
-
-            /// <summary>
-            /// Send a message to a specific peer or group of peers.
-            /// </summary>
-            SendMessage,
-
-            /// <summary>
-            /// Send a ping to a specific peer to check its availability.
-            /// </summary>
-            PingPeer,
-
-            /// <summary>
-            /// Disconnect a specific peer from the network.
-            /// </summary>
-            DisconnectPeer,
-
-            /// <summary>
-            /// Authorize a peer to perform certain actions or access certain resources.
-            /// </summary>
-            AuthorizePeer,
-
-            /// <summary>
-            /// Revoke the authorization of a peer.
-            /// </summary>
-            RevokePeerAuthorization,
-
-            /// <summary>
-            /// Request specific data from a peer.
-            /// </summary>
-            RequestData,
-
-            /// <summary>
-            /// Send specific data to a peer.
-            /// </summary>
-            SendData,
-
-            /// <summary>
-            /// Synchronize data between peers.
-            /// </summary>
-            SynchronizeData,
-
-            /// <summary>
-            /// Update network settings or peer settings.
-            /// </summary>
-            UpdateSettings,
-
-            /// <summary>
-            /// Verify the PGP signature of a message or command.
-            /// </summary>
-            VerifySignature,
-
-            /// <summary>
-            /// Request the public key of a peer or bootstrap server.
-            /// </summary>
-            RequestPublicKey,
-
-            /// <summary>
-            /// Send the public key to a peer or bootstrap server.
-            /// </summary>
-            SendPublicKey,
-
-            /// <summary>
-            /// Send a heartbeat signal to check the status of a peer or server.
-            /// </summary>
-            Heartbeat
-        }
-
     /// <summary>
-    /// Represents a network task that can be executed within the peer-to-peer network.
+    /// This region keeps the packet objects and classes AOT compliant for JSON serialization.
     /// </summary>
-    /// <remarks>
-    /// A network task defines an action to be performed, such as blocking a peer, sending a message, or synchronizing data.
-    /// Each task is identified by a <see cref="TaskType"/> and can include additional data in the form of key-value pairs.
-    /// </remarks>
-    public sealed class NetworkTask
-    {
-        public TaskType TaskType { get; set; }
-        public Dictionary<string, string> TaskData { get; set; }
-
-        [JsonConstructor]
-        public NetworkTask() { }
-
-        public byte[] ToByte()
-        {
-            return Encoding.UTF8.GetBytes(Distribution_Protocol.Serialize(this));
-        }
-    }
-
-    #endregion
-
     #region PACKET_CONTEXT
         [JsonSerializable(typeof(PureMessagePacket))]
         public partial class PureMessagePacketContext : JsonSerializerContext { }

P2PNet/Distribution/NetworkTasks/NetworkTask.cs

@@ -0,0 +1,120 @@
+using System.Text;
+using System.Text.Json.Serialization;
+
+namespace P2PNet.Distribution.NetworkTasks
+    {
+    /// <summary>
+    /// Represents a network task that can be executed within the peer-to-peer network.
+    /// </summary>
+    /// <remarks>
+    /// A network task defines an action to be performed, such as blocking a peer, sending a message, or synchronizing data.
+    /// Each task is identified by a <see cref="TaskType"/> and can include additional data in the form of key-value pairs.
+    /// </remarks>
+    public sealed class NetworkTask
+    {
+        public TaskType TaskType { get; set; }
+        public Dictionary<string, string> TaskData { get; set; }
+
+        [JsonConstructor]
+        public NetworkTask() { }
+
+        public byte[] ToByte()
+        {
+            return Encoding.UTF8.GetBytes(Serialize(this));
+        }
+    }
+
+    /// <summary>
+    /// Defines the types of tasks that can be executed within the peer-to-peer network.
+    /// </summary>
+    public enum TaskType
+    {
+        /// <summary>
+        /// Block a peer and removes it from the network.
+        /// </summary>
+        BlockAndRemovePeer,
+
+        /// <summary>
+        /// Block a specific IP address from connecting to the network.
+        /// </summary>
+        BlockIP,
+
+        /// <summary>
+        /// Send a message to a specific peer or group of peers.
+        /// </summary>
+        SendMessage,
+
+        /// <summary>
+        /// Send a ping to a specific peer to check its availability.
+        /// </summary>
+        PingPeer,
+
+        /// <summary>
+        /// Disconnect a specific peer from the network.
+        /// </summary>
+        DisconnectPeer,
+
+        /// <summary>
+        /// Authorize a peer to perform certain actions or access certain resources.
+        /// </summary>
+        AuthorizePeer,
+
+        /// <summary>
+        /// Revoke the authorization of a peer.
+        /// </summary>
+        RevokePeerAuthorization,
+
+        /// <summary>
+        /// Request specific data from a peer.
+        /// </summary>
+        RequestData,
+
+        /// <summary>
+        /// Send specific data to a peer.
+        /// </summary>
+        SendData,
+
+        /// <summary>
+        /// Synchronize data between peers.
+        /// </summary>
+        SynchronizeData,
+
+        /// <summary>
+        /// Update network settings or peer settings.
+        /// </summary>
+        UpdateSettings,
+
+        /// <summary>
+        /// Verify the PGP signature of a message or command.
+        /// </summary>
+        VerifySignature,
+
+        /// <summary>
+        /// Request the public key of a peer or bootstrap server.
+        /// </summary>
+        RequestPublicKey,
+
+        /// <summary>
+        /// Send the public key to a peer or bootstrap server.
+        /// </summary>
+        SendPublicKey,
+
+        /// <summary>
+        /// Send a heartbeat signal to check the status of a peer or server.
+        /// </summary>
+        /// <remarks>This can be useful with bootstrap servers to track if peers are still live or drop off the network.</remarks>
+        Heartbeat,
+
+        /// <summary>
+        /// Set the local identifier to the specified value.
+        /// </summary>
+        /// <remarks>This can be useful with the Authority trust policy to assign unique IDs to peers.</remarks>
+        AcceptIdentifier,
+
+        /// <summary>
+        /// Set the identifier of a peer to the specified value.
+        /// </summary>
+        AssignIdentifierToPeer,
+    }
+
+}

P2PNet/NetworkPackets/CollectionSharePacket.cs

@@ -11,7 +11,7 @@
 namespace P2PNet.NetworkPackets
 {
     /// <summary>
-    /// Standard packet used to relay a collection of peer-identifying information through out a network.
+    /// Standard packet used to relay a collection of peers on the network using peer-identifying information.
     /// </summary>
     public class CollectionSharePacket : INetworkPacket
         {

P2PNet/NetworkPackets/DataTransmissionPacket.cs

@@ -1,16 +1,18 @@
-using static P2PNet.Distribution.Distribution_Protocol;
+using static P2PNet.Distribution.DistributionProtocol;
 using P2PNet.NetworkPackets;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using P2PNet.Distribution.NetworkTasks;
 
 namespace P2PNet.NetworkPackets
     {
     /// <summary>
-    /// Represents a data transmission packet used for transmitting data throughout the peer network.
+    /// Represents a data transmission packet used for transmitting data throughout the peer-to-peer network.
     /// </summary>
+    /// <remarks>This packet can be used to transmit <see cref="NetworkTask"/> and files throughout the network.</remarks>
     public sealed class DataTransmissionPacket : INetworkPacket
         {
         /// <summary>

P2PNet/P2PNet.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
 	<IsPackable>true</IsPackable>
@@ -33,7 +33,7 @@ Including PacketDotNet and SharpPcap as dependencies.</PackageReleaseNotes>
   </ItemGroup>
 
   <ItemGroup>
-    <Using Include="P2PNet.Distribution.Distribution_Protocol">
+    <Using Include="P2PNet.Distribution.DistributionProtocol">
       <Static>True</Static>
     </Using>
     <Using Include="System.Timers.Timer">

P2PNet/PeerNetwork.cs

@@ -60,6 +60,7 @@ public static class PeerNetwork
 
         /// <summary>
         /// Gets or sets whether a designated TCP port will be actively listening for and accepting inbound TCP peer connections.
+        /// Setting this value will automatically start or stop acceptance of inbound peers.
         /// The default is true, but you may want to toggle this for server instances that serve different network purposes.
         /// </summary>
         public static bool AcceptInboundPeers 

P2PNet/Peers/PeerChannel.cs

@@ -13,24 +13,37 @@
 
 namespace P2PNet.Peers
 {
+    /// <summary>
+    /// Represents a communication channel with a peer in the P2P network.
+    /// </summary>
     public class PeerChannel : PeerChannel_Base
         {
         /// <summary>
         /// Gets the DateTime value of when the last piece of data or information was received from this peer.
         /// </summary>
         public DateTime LastIncomingDataReceived { get; internal set; } = DateTime.Now;
 
+        /// <summary>
+        /// Gets or sets the peer associated with this channel.
+        /// </summary>
         public IPeer peer { get; set; }
 
         private int RETRIES = 0; // for retrying connections
         public int GOODPINGS { get; internal set; } = 0; // readonly
         private const int MAX_RETRIES = 3;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PeerChannel"/> class with the specified peer.
+        /// </summary>
+        /// <param name="peer_">The peer to associate with this channel.</param>
         public PeerChannel(IPeer peer_)
             {
             peer = peer_;
             }
 
+        /// <summary>
+        /// Opens the communication channel with the peer and starts handling incoming and outgoing data.
+        /// </summary>
         public async void OpenPeerChannel()
             {
             cancelSender = new CancellationTokenSource();        
@@ -52,6 +65,10 @@ public async void OpenPeerChannel()
                 Task.Run(() => CreatePing());
                 }
             }
+
+        /// <summary>
+        /// Closes the communication channel with the peer and terminates all associated tasks.
+        /// </summary>
         public void ClosePeerChannel()
             {
             if ((cancelSender != null) && (cancelReceiver != null))