diff --git a/source/Cosmos.System2/Network/NetworkStack.cs b/source/Cosmos.System2/Network/NetworkStack.cs index 8cf1a5db6..6ea9d2c6d 100644 --- a/source/Cosmos.System2/Network/NetworkStack.cs +++ b/source/Cosmos.System2/Network/NetworkStack.cs @@ -13,14 +13,20 @@ namespace Cosmos.System.Network /// public static class NetworkStack { - + /// + /// Debugger inctanse of the "System" ring, with the "NetworkStack" tag. + /// public static Debugger debugger = new Debugger("System", "NetworkStack"); + /// + /// Get address dictionary. + /// internal static TempDictionary AddressMap { get; private set; } /// - /// Initialize the Network Stack to prepare it for operation + /// Initialize the Network Stack to prepare it for operation. /// + /// Thrown on fatal error (contact support). public static void Init() { AddressMap = new TempDictionary(); @@ -42,8 +48,17 @@ namespace Cosmos.System.Network /// Multiple IP Configurations can be made, like *nix environments /// /// that will have the assigned configuration - /// instance that defines the IP Address, Subnet + /// instance that defines the IP Address, Subnet /// Mask and Default Gateway for the device + /// + /// + /// Thrown if configuration with the given config.IPAddress.Hash already exists. + /// Thrown on fatal error (contact support). + /// + /// + /// Thrown on fatal error (contact support). + /// Thrown on IO error. + /// Thrown on fatal error (contact support). public static void ConfigIP(NetworkDevice nic, Config config) { AddressMap.Add(config.IPAddress.Hash, nic); @@ -51,6 +66,14 @@ namespace Cosmos.System.Network nic.DataReceived = HandlePacket; } + /// + /// Handle packet. + /// + /// Packet data array. + /// Thrown on fatal error (contact support). + /// Thrown on IO error. + /// Thrown on fatal error (contact support). + /// Thrown on fatal error (contact support). internal static void HandlePacket(byte[] packetData) { debugger.Send("Packet Received Length=" + packetData.Length.ToString()); @@ -75,6 +98,9 @@ namespace Cosmos.System.Network /// /// Called continously to keep the Network Stack going. /// + /// Thrown on fatal error (contact support). + /// Thrown on memory error. + /// Thrown if data length of any packet in the queue is bigger than Int32.MaxValue. public static void Update() { OutgoingBuffer.Send();