Skip to content
Snippets Groups Projects
Commit 3fabf8b2 authored by tho's avatar tho
Browse files

fixed some typos

parent a6038f6d
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
PPI/Connectors.hh
+ 5
− 5
View file @ 3fabf8b2
...@@ -143,7 +143,7 @@ namespace connector { ...@@ -143,7 +143,7 @@ namespace connector {
this input. In the second case, the pointer will this input. In the second case, the pointer will
automatically be bound to the containing instance. automatically be bound to the containing instance.
\param[in] handler Handler to call on throttle \param[in] handle Handler to call on throttle
notifications. */ notifications. */
template <class Handler> template <class Handler>
...@@ -155,7 +155,7 @@ namespace connector { ...@@ -155,7 +155,7 @@ namespace connector {
holds this input. In the second case, the pointer will holds this input. In the second case, the pointer will
automatically be bound to the containing instance. automatically be bound to the containing instance.
\param[in] handler Handler to call on unthrottle \param[in] handle Handler to call on unthrottle
notifications. */ notifications. */
PassiveConnector & peer(); PassiveConnector & peer();
...@@ -204,7 +204,7 @@ namespace connector { ...@@ -204,7 +204,7 @@ namespace connector {
exception is raised. */ exception is raised. */
operator unspecified_boolean_type (); ///< Check packet availability operator unspecified_boolean_type (); ///< Check packet availability
/**< Using any input connector in a boolean context will /**< 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 is always possible if the queue is non-empty. If the
input is active, it also returns when the connected input is active, it also returns when the connected
passive output is not throttled so new packets can be passive output is not throttled so new packets can be
...@@ -264,7 +264,7 @@ namespace connector { ...@@ -264,7 +264,7 @@ namespace connector {
queue throttling state. This state is automatically managed by a queueing discipline. The queue throttling state. This state is automatically managed by a queueing discipline. The
standard queueing discipline is ThresholdQueueing, which throttles the connection whenever standard queueing discipline is ThresholdQueueing, which throttles the connection whenever
the queue length reaches the high threshold and unthrottles the connection when the queue 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 <tt>ThresholdQueueing(1,0)</tt> which will throttle the input whenever the queue is
non-empty. non-empty.
*/ */
...@@ -299,7 +299,7 @@ namespace connector { ...@@ -299,7 +299,7 @@ namespace connector {
public: public:
PassiveOutput & peer(); 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 /** \brief Combination of ActiveConnector and OutputConnector
......
PPI/Events.hh
+ 2
− 2
View file @ 3fabf8b2
...@@ -34,7 +34,7 @@ namespace ppi { ...@@ -34,7 +34,7 @@ namespace ppi {
/** \brief Generic event interface baseclass /** \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. way. This allows to register events or to temporarily disable event processing.
*/ */
class EventDescriptor class EventDescriptor
...@@ -53,7 +53,7 @@ namespace ppi { ...@@ -53,7 +53,7 @@ namespace ppi {
virtual void v_register(CallbackType handler) = 0; ///< Called to register the event 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_unregister() = 0; ///< Called to unregister the event
virtual void v_enable() = 0; ///< Called to enable the event delivery 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 virtual void v_process() = 0; ///< Called whenever the event is signaled
/**< This virtual method is called \e after every call to /**< This virtual method is called \e after every call to
the event handler to provide a hook for further the event handler to provide a hook for further
......
PPI/Mainpage.dox
+ 3
− 3
View file @ 3fabf8b2
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
/** \mainpage libPPI : The Packet Processing Infrastructure /** \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 applications. A PPI application is built by combining processing modules in a very flexible
manner. manner.
...@@ -205,7 +205,7 @@ ...@@ -205,7 +205,7 @@
up. The buffering on the udpInput <-> rateStuffer adaptor is changed so the queue will begin to 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 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 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. fixed rate of 10 packets / second.
\section throttling Throttling \section throttling Throttling
...@@ -294,7 +294,7 @@ ...@@ -294,7 +294,7 @@
by the template argument. by the template argument.
We register an IOSignaler event. This event will be signaled whenever the socket is 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. 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 Processing arriving packets happens in the \c data() member: This member simple reads a packet
......
PPI/Module.hh
+ 2
− 2
View file @ 3fabf8b2
...@@ -79,9 +79,9 @@ namespace module { ...@@ -79,9 +79,9 @@ namespace module {
The return value may be used to alter routing The return value may be used to alter routing
parameters like throttling parameters. parameters like throttling parameters.
\param[in] source Data source, object which controlls \param[in] source Data source, object which controls
incoming data incoming data
\param[in] target Data target, object which controlls \param[in] target Data target, object which controls
outgoing data outgoing data
\returns Route instance describing this route */ \returns Route instance describing this route */
......
PPI/PassiveQueue.hh
+ 1
− 1
View file @ 3fabf8b2
...@@ -52,7 +52,7 @@ namespace module { ...@@ -52,7 +52,7 @@ namespace module {
PassiveQueue(); PassiveQueue();
void qdisc(QueueingDiscipline const & disc); ///< Change the queueing discipline 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. the \a input connector.
\see connector::PassiveInput::qdisc() */ \see connector::PassiveInput::qdisc() */
......
PPI/Queueing.hh
+ 1
− 1
View file @ 3fabf8b2
...@@ -54,7 +54,7 @@ namespace ppi { ...@@ -54,7 +54,7 @@ namespace ppi {
called to calculate the new throttling state. called to calculate the new throttling state.
\param[in] input Connector holding the queue \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 */ \returns new throttling state */
}; };
......
PPI/SocketReader.hh
+ 2
− 2
View file @ 3fabf8b2
...@@ -77,7 +77,7 @@ namespace module { ...@@ -77,7 +77,7 @@ namespace module {
class SomeReader class SomeReader
{ {
public: public:
typedef unspecified_type Handle; // type of handle reqeusted typedef unspecified_type Handle; // type of handle requested
SomeReader(); // default constructible SomeReader(); // default constructible
Packet::ptr operator()(Handle handle); // extraction function Packet::ptr operator()(Handle handle); // extraction function
}; };
...@@ -89,7 +89,7 @@ namespace module { ...@@ -89,7 +89,7 @@ namespace module {
public: public:
typedef typename Reader::Handle Handle; ///< Handle type requested by the reader 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 ActiveSocketReader(Handle handle); ///< Create new reader for the given handle
/**< Data will be read from \a handle and be parsed by \a /**< Data will be read from \a handle and be parsed by \a
......
PPI/SocketWriter.hh
+ 1
− 1
View file @ 3fabf8b2
...@@ -37,7 +37,7 @@ namespace ppi { ...@@ -37,7 +37,7 @@ namespace ppi {
/** \brief Write helper for module::ActiveSocketWriter / module::PassiveSocketWriter /** \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 class PacketWriter
{ {
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Datenschutz und Impressum