Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
senf
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
wiback
senf
Commits
191b45f9
Commit
191b45f9
authored
17 years ago
by
tho
Browse files
Options
Downloads
Patches
Plain Diff
some small doc fixes
parent
9c4201a1
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
PPI/Connectors.hh
+2
-2
2 additions, 2 deletions
PPI/Connectors.hh
PPI/Mainpage.dox
+8
-8
8 additions, 8 deletions
PPI/Mainpage.dox
PPI/Module.hh
+4
-4
4 additions, 4 deletions
PPI/Module.hh
PPI/SocketSource.hh
+2
-2
2 additions, 2 deletions
PPI/SocketSource.hh
with
16 additions
and
16 deletions
PPI/Connectors.hh
+
2
−
2
View file @
191b45f9
...
...
@@ -277,7 +277,7 @@ namespace connector {
logic error in the module implementation and an
exception is raised. */
Packet
read
();
///< Alias for
\ref
operator()()
Packet
read
();
///< Alias for operator()()
OutputConnector
&
peer
()
const
;
...
...
@@ -315,7 +315,7 @@ namespace connector {
public:
void
operator
()(
Packet
p
);
///< Send out a packet
void
write
(
Packet
p
);
///< Alias for
\ref
operator()()
void
write
(
Packet
p
);
///< Alias for operator()(
Packet p
)
InputConnector
&
peer
()
const
;
...
...
This diff is collapsed.
Click to expand it.
PPI/Mainpage.dox
+
8
−
8
View file @
191b45f9
...
...
@@ -102,9 +102,9 @@
Of these modules, normally only the application modules need to be implemented since the library
provides an extensive set of reusable modules.
The following example module declares three \ref ppi_connectors: \c payload,
\c stuffing and
\c output. These connectors are defined as \e public data members so they
can be accessed from
the outside. This is important as we will see below.
The following example module declares three \ref ppi_connectors
"Connectors"
: \c payload,
\c
stuffing and \c
output. These connectors are defined as \e public data members so they
can be accessed from
the outside. This is important as we will see below.
\code
class RateStuffer
...
...
@@ -306,11 +306,11 @@
example by manually throttling some passive connector (see \ref
senf::ppi::connector::PassiveConnector).
To enable/disable automatic throttling, the \ref senf::ppi::Module::route() command
returns a
reference to a \ref senf::ppi::Route instance. If this route is \e forwarding route,
(that is,
of the connectors is passive and the other is active), the return value will be
derived from
\ref senf::ppi::ForwardingRoute which provides members to control the throttle
notification
forwarding.
To enable/disable automatic throttling, the \ref senf::ppi::
module::
Module::route() command
returns a
reference to a \ref senf::ppi::Route instance. If this route is \e forwarding route,
(that is,
of the connectors is passive and the other is active), the return value will be
derived from
\ref senf::ppi::ForwardingRoute which provides members to control the throttle
notification
forwarding.
\see
senf::ppi::module::Module \n
...
...
This diff is collapsed.
Click to expand it.
PPI/Module.hh
+
4
−
4
View file @
191b45f9
...
...
@@ -198,9 +198,9 @@ namespace module {
The return value may be used to alter routing
parameters like throttling parameters.
\param[in]
source
Data source, object which controls
\param[in]
input
Data source, object which controls
incoming data (connector or event)
\param[in]
targe
t Data target, object which controls
\param[in]
outpu
t Data target, object which controls
outgoing data (connector or event)
\returns Route instance describing this route
\see \ref ppi_throttling
...
...
@@ -227,8 +227,8 @@ namespace module {
route
(
EventDescriptor
&
input
,
connector
::
OutputConnector
&
output
);
///< Define flow information
/**< Route from an event to a connector. Routing from an
event to a connector def
e
ines the event as the
conceptual 'source' of the data. T
H
is means, the event
event to a connector defines the event as the
conceptual 'source' of the data. T
h
is means, the event
controls how packets are sent (Example: Routing from an
IOEVent to an output defines, that output data will be
generated whenever the event is signaled).
...
...
This diff is collapsed.
Click to expand it.
PPI/SocketSource.hh
+
2
−
2
View file @
191b45f9
...
...
@@ -44,8 +44,8 @@ namespace ppi {
This read helper will read a datagram from a datagram socket. This datagram will then be
interpreted as a packet of type \a Packet as defined in the packet library. \a Packet
defaults to
\ref
DataPacket, which will place the data uninterpreted
into a packet data
structure.
defaults to
DataPacket (type
DataPacket
Type)
, which will place the data uninterpreted
into a packet data
structure.
*/
template
<
class
Packet
=
DataPacket
>
class
PacketSource
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment