senf::ppi::connector::ActiveInput< PacketType > Class Template Reference
Connector actively reading packets. More...
#include <senf/PPI/Connectors.hh>
Inheritance diagram for senf::ppi::connector::ActiveInput< PacketType >:
Public Member Functions | |
| PacketType const & | operator() () |
| Read packet. More... | |
| PacketType const & | read () |
| Alias for operator() More... | |
 Public Member Functions inherited from senf::ppi::connector::GenericActiveInput | |
| GenericPassiveOutput & | peer () const |
| bool | boolean_test () const |
true, if ! empty() or ! throttled() More... | |
| void | request () |
| request more packets without dequeuing any packet More... | |
| Public Member Functions inherited from senf::ppi::connector::ActiveConnector | |
| ~ActiveConnector () | |
| template<class Handler > | |
| void | onThrottle (Handler handler) |
| Register throttle notification handler. More... | |
| void | onThrottle () |
| Clear throttle notification handler. More... | |
| template<class Handler > | |
| void | onUnthrottle (Handler handler) |
| Register unthrottle notification handler. More... | |
| void | onUnthrottle () |
| Clear unthrottle notification handler. More... | |
| bool | throttled () const |
true, if peer() is throttled More... | |
| PassiveConnector & | peer () const |
| Public Member Functions inherited from senf::ppi::connector::Connector | |
| Connector & | peer () const |
| Get peer connected to this connector. More... | |
| module::Module & | module () const |
| Get this connectors containing module. More... | |
| bool | connected () const |
true, if connector connected, false otherwise More... | |
| void | disconnect () |
| Disconnect connector from peer. More... | |
| console::DirectoryNode & | consoleDir () const |
| void | tracingState (TraceState state) |
| TraceState | tracingState () const |
| Public Member Functions inherited from senf::ppi::connector::InputConnector | |
| Packet const & | operator() () |
| Get a packet. More... | |
| Packet const & | read () |
| Alias for operator()() More... | |
| OutputConnector & | peer () const |
| size_type | queueSize () const |
| Return number of elements in the queue. More... | |
| bool | empty () const |
| Return queueSize() == 0. More... | |
| Public Member Functions inherited from senf::comparable_safe_bool< class > | |
| operator bool_type () const | |
| bool | operator! () const |
Additional Inherited Members | |
| Public Types inherited from senf::ppi::connector::Connector | |
| enum | TraceState { NO_TRACING, TRACE_IDS, TRACE_CONTENTS } |
| Public Types inherited from senf::ppi::connector::InputConnector | |
| typedef Queue::const_iterator | queue_iterator |
| Iterator type of the embedded queue. More... | |
| typedef Queue::size_type | size_type |
| Unsigned type for counting queue elements. More... | |
| Static Public Member Functions inherited from senf::ppi::connector::Connector | |
| static void | staticTracingState (TraceState state) |
| static void | tracingFilter (std::string const &traceFilter) |
| Protected Types inherited from senf::safe_bool_base | |
| typedef void(safe_bool_base::* | bool_type) () const |
| Protected Member Functions inherited from senf::ppi::connector::GenericActiveInput | |
| GenericActiveInput () | |
| virtual void | v_disconnected () |
| virtual void | v_connected () |
| Protected Member Functions inherited from senf::ppi::connector::ActiveConnector | |
| ActiveConnector () | |
| Protected Member Functions inherited from senf::ppi::connector::Connector | |
| Connector () | |
| virtual | ~Connector () |
| void | connect (Connector &target) |
| void | trace (Packet const &p, char const *label) |
| void | throttleTrace (char const *label, char const *type) |
| void | unregisterConnector () |
| Protected Member Functions inherited from senf::ppi::connector::InputConnector | |
| InputConnector () | |
| Protected Member Functions inherited from senf::comparable_safe_bool< class > | |
| ~comparable_safe_bool () | |
| Protected Member Functions inherited from senf::safe_bool_base | |
| void | this_type_does_not_support_comparisons () const |
| safe_bool_base () | |
| safe_bool_base (const safe_bool_base &) | |
| safe_bool_base & | operator= (const safe_bool_base &) |
| ~safe_bool_base () | |
Detailed Description
template<class PacketType = Packet>
class senf::ppi::connector::ActiveInput< PacketType >
Connector actively reading packets.
- Template Parameters
-
PacketType Type of packet to read. Defaults to senf::Packet
The ActiveInput connector template reads data actively from a connected module. This class is completely implemented via it's base-class, GenericActiveInput, the only difference is that read packets are returned as PacketType instead of generic senf::Packet references.
Definition at line 632 of file Connectors.hh.
Member Function Documentation
◆ operator()()
template<class PacketType = Packet>
| PacketType const& senf::ppi::connector::ActiveInput< PacketType >::operator() | ( | ) |
Read packet.
- Exceptions
-
std::bad_cast if the connector receives a Packet which is not of type PacketType.
- Returns
- newly read packet reference.
◆ read()
template<class PacketType = Packet>
| PacketType const& senf::ppi::connector::ActiveInput< PacketType >::read | ( | ) |
Alias for operator()
The documentation for this class was generated from the following file: