diff --git a/src/pnp2/include/pnp2/NetworkProfile.hpp b/src/pnp2/include/pnp2/NetworkProfile.hpp index 26f21ff..1650cc7 100644 --- a/src/pnp2/include/pnp2/NetworkProfile.hpp +++ b/src/pnp2/include/pnp2/NetworkProfile.hpp @@ -1,6 +1,7 @@ /** \file NetworkProfile.hpp * - * This file declares the ResourceEntry and NetworkProfile classes. + * This file declares the Network::ResourceEntry and + * Network::NetworkProfile classes. */ #ifndef NETWORK_PROFILE_HPP diff --git a/src/pnp2/include/pnp2/receiver.hpp b/src/pnp2/include/pnp2/receiver.hpp index daef0e0..c6d0f55 100644 --- a/src/pnp2/include/pnp2/receiver.hpp +++ b/src/pnp2/include/pnp2/receiver.hpp @@ -1,3 +1,8 @@ +/** \file receiver.hpp + * + * This file declares the Network::receiver class + */ + #ifndef NETWORK_RECEIVER_HPP #define NETWORK_RECEIVER_HPP @@ -13,6 +18,14 @@ namespace Network { + /** + Allows for the reception of data through a (possibly fixed-size) + buffer at a configurable rate that can vary as a function of + time. Optionally enables out-of-band (oob) communication to + senders to shut them off if the buffer is filling up too fast. + The receiver also records the reception of data (size, time) into + memory for later dump to disk. + */ class receiver { public: diff --git a/src/pnp2/include/pnp2/sender.hpp b/src/pnp2/include/pnp2/sender.hpp index b2496ea..adabb05 100644 --- a/src/pnp2/include/pnp2/sender.hpp +++ b/src/pnp2/include/pnp2/sender.hpp @@ -1,3 +1,8 @@ +/** \file sender.hpp + * + * This file declares the Network::sender class. + */ + #ifndef NETWORK_SENDER_HPP #define NETWORK_SENDER_HPP @@ -16,8 +21,21 @@ namespace Network { + /** + Exception class thrown when application exceeds allowed data + production. + */ class Exceeded_Production_profile {}; // sender-side exception + /** + Allows for the sending of data (possibly through a buffer) at a + configurable rate and with configurable push-back to inform if + the rate has been exceeded. Can also optionally receive + out-of-band (oob) push-backs from its associated receiver classes + to disable sending while they empty their receive buffers. The + sender also records the sending of data (size, time) into memory + for later dump to disk. + */ class sender { public: