diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 7305d9ffdfb3970a914015801e5348a5f1c58f18..d82e14a8c41b981c51228602e7ac1967f02dcfea 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -143,7 +143,7 @@ namespace connector { this input. In the second case, the pointer will automatically be bound to the containing instance. - \param[in] handler Handler to call on throttle + \param[in] handle Handler to call on throttle notifications. */ template <class Handler> @@ -155,7 +155,7 @@ namespace connector { holds this input. In the second case, the pointer will automatically be bound to the containing instance. - \param[in] handler Handler to call on unthrottle + \param[in] handle Handler to call on unthrottle notifications. */ PassiveConnector & peer(); @@ -204,7 +204,7 @@ namespace connector { exception is raised. */ operator unspecified_boolean_type (); ///< Check packet availability /**< Using any input connector in a boolean context will - check, wether an input request can be fulfilled. This + check, whether an input request can be fulfilled. This is always possible if the queue is non-empty. If the input is active, it also returns when the connected passive output is not throttled so new packets can be @@ -264,7 +264,7 @@ namespace connector { queue throttling state. This state is automatically managed by a queueing discipline. The standard queueing discipline is ThresholdQueueing, which throttles the connection whenever the queue length reaches the high threshold and unthrottles the connection when the queue - reaches the low threshold. The default queueing discpiline is + reaches the low threshold. The default queueing discipline is <tt>ThresholdQueueing(1,0)</tt> which will throttle the input whenever the queue is non-empty. */ @@ -299,7 +299,7 @@ namespace connector { public: PassiveOutput & peer(); - void request(); ///< request more packets without dequeing any packet + void request(); ///< request more packets without dequeuing any packet }; /** \brief Combination of ActiveConnector and OutputConnector diff --git a/PPI/Events.hh b/PPI/Events.hh index 0a89adb062dfe107d0794e2421f427879209f668..ed35f1f32a7c150bc2873c3012333e8fe4864a20 100644 --- a/PPI/Events.hh +++ b/PPI/Events.hh @@ -34,7 +34,7 @@ namespace ppi { /** \brief Generic event interface baseclass - The EventDescriptor baseclass provides an interface to manuplate events in a generic + The EventDescriptor baseclass provides an interface to manipulate events in a generic way. This allows to register events or to temporarily disable event processing. */ class EventDescriptor @@ -53,7 +53,7 @@ namespace ppi { virtual void v_register(CallbackType handler) = 0; ///< Called to register the event virtual void v_unregister() = 0; ///< Called to unregister the event virtual void v_enable() = 0; ///< Called to enable the event delivery - virtual void v_disable() = 0; ///< Called to disable the event delilvery + virtual void v_disable() = 0; ///< Called to disable the event delivery virtual void v_process() = 0; ///< Called whenever the event is signaled /**< This virtual method is called \e after every call to the event handler to provide a hook for further diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox index 90012b39129d4f5b5269e17db6f28050e660faf2..2020f02fc17d23cc7348ca479d9eae5437ae2dbe 100644 --- a/PPI/Mainpage.dox +++ b/PPI/Mainpage.dox @@ -20,7 +20,7 @@ /** \mainpage libPPI : The Packet Processing Infrastructure - The PPI provides an infrastructure to create packet oriented network processin + The PPI provides an infrastructure to create packet oriented network processing applications. A PPI application is built by combining processing modules in a very flexible manner. @@ -205,7 +205,7 @@ up. The buffering on the udpInput <-> rateStuffer adaptor is changed so the queue will begin to throttle only if more than 10 packets are in the queue. The connection will be unthrottled as soon as there are no more than 5 packets left in the queue. This application will read - udp-packts coming in on port 1111 and will forward them to port 2222 on host 2.3.4.5 with a + udp-packets coming in on port 1111 and will forward them to port 2222 on host 2.3.4.5 with a fixed rate of 10 packets / second. \section throttling Throttling @@ -294,7 +294,7 @@ by the template argument. We register an IOSignaler event. This event will be signaled whenever the socket is - readable. This event is routet to the output. This routing automates throttling for the socket: + readable. This event is routed to the output. This routing automates throttling for the socket: Whenever the output receives a throttle notifications, the event will be temporarily disabled. Processing arriving packets happens in the \c data() member: This member simple reads a packet diff --git a/PPI/Module.hh b/PPI/Module.hh index 0c9894c0c5ef1be6dbf0e379a1700d8de4c883de..6f998c0417e2657d4fda5cf098b120384f5640b6 100644 --- a/PPI/Module.hh +++ b/PPI/Module.hh @@ -79,9 +79,9 @@ namespace module { The return value may be used to alter routing parameters like throttling parameters. - \param[in] source Data source, object which controlls + \param[in] source Data source, object which controls incoming data - \param[in] target Data target, object which controlls + \param[in] target Data target, object which controls outgoing data \returns Route instance describing this route */ diff --git a/PPI/PassiveQueue.hh b/PPI/PassiveQueue.hh index ba2888887180ed7567ef5ae549647dfbcbeec548..5bc0d2ab7659f0e4b77c5e4c73bdbef78c59ce1e 100644 --- a/PPI/PassiveQueue.hh +++ b/PPI/PassiveQueue.hh @@ -52,7 +52,7 @@ namespace module { PassiveQueue(); void qdisc(QueueingDiscipline const & disc); ///< Change the queueing discipline - /**< This call changs the queueing discipline of the queue. This call is just forwarded to + /**< This call changes the queueing discipline of the queue. This call is just forwarded to the \a input connector. \see connector::PassiveInput::qdisc() */ diff --git a/PPI/Queueing.hh b/PPI/Queueing.hh index 7410318552217dd386f4bc144816b6e0fad7aee8..7ac162e9978e4b4da530ccbca34117a7079b223d 100644 --- a/PPI/Queueing.hh +++ b/PPI/Queueing.hh @@ -54,7 +54,7 @@ namespace ppi { called to calculate the new throttling state. \param[in] input Connector holding the queue - \param[in] event Type of event triggering the upate + \param[in] event Type of event triggering the update \returns new throttling state */ }; diff --git a/PPI/SocketReader.hh b/PPI/SocketReader.hh index 57326e3123455cb070f55bce3ff683987fe25e35..2b1245b01909cf7d69e79d94ee2a17e85dc96231 100644 --- a/PPI/SocketReader.hh +++ b/PPI/SocketReader.hh @@ -77,7 +77,7 @@ namespace module { class SomeReader { public: - typedef unspecified_type Handle; // type of handle reqeusted + typedef unspecified_type Handle; // type of handle requested SomeReader(); // default constructible Packet::ptr operator()(Handle handle); // extraction function }; @@ -89,7 +89,7 @@ namespace module { public: typedef typename Reader::Handle Handle; ///< Handle type requested by the reader - connector::ActiveOutput output; ///< Output connector to which the data recevied is writtten + connector::ActiveOutput output; ///< Output connector to which the data received is written ActiveSocketReader(Handle handle); ///< Create new reader for the given handle /**< Data will be read from \a handle and be parsed by \a diff --git a/PPI/SocketWriter.hh b/PPI/SocketWriter.hh index 7c14c23f4cf24fbdb622fe6a7cb8052252e00f92..b954e9a59f9a89cd320085e7b02ba8542a30c227 100644 --- a/PPI/SocketWriter.hh +++ b/PPI/SocketWriter.hh @@ -37,7 +37,7 @@ namespace ppi { /** \brief Write helper for module::ActiveSocketWriter / module::PassiveSocketWriter - This write helper will write the packets completely as datagrmas to the given socket. + This write helper will write the packets completely as datagrams to the given socket. */ class PacketWriter {