#include <conn_input_endpoint.hpp>
Public Member Functions | |
| ConnInputEndpoint (ConnectionBasePtr publication) | |
| virtual void | disconnect (bool forward) |
| virtual bool | inputReady () |
| virtual FlowStatus | read (typename ChannelElement< M >::reference_t sample) |
| ~ConnInputEndpoint () | |
Private Attributes | |
| ConnectionBasePtr | publication_ |
Detailed Description
template<typename M>
class micros_rtt::ConnInputEndpoint< M >
This is a channel element that represents the input endpoint of a connection, i.e. the part that is connected to the OutputPort
Definition at line 31 of file conn_input_endpoint.hpp.
Constructor & Destructor Documentation
| micros_rtt::ConnInputEndpoint< M >::ConnInputEndpoint | ( | ConnectionBasePtr | publication | ) | [inline] |
Definition at line 36 of file conn_input_endpoint.hpp.
| micros_rtt::ConnInputEndpoint< M >::~ConnInputEndpoint | ( | ) | [inline] |
Definition at line 38 of file conn_input_endpoint.hpp.
Member Function Documentation
| virtual void micros_rtt::ConnInputEndpoint< M >::disconnect | ( | bool | forward | ) | [inline, virtual] |
Performs a disconnection of this channel's endpoints. If forward is true, then the disconnection is initiated by the input endpoint. Otherwise, it has been initiated by the output endpoint.
Reimplemented from micros_rtt::ChannelElementBase.
Definition at line 55 of file conn_input_endpoint.hpp.
| virtual bool micros_rtt::ConnInputEndpoint< M >::inputReady | ( | ) | [inline, virtual] |
This is called by an input port when it is ready to receive data. Each channel element has the responsibility to pass this notification on to the next, in the direction of the output.
- Returns:
- false if a fatal connection failure was encountered and the channel needs to be destroyed.
Reimplemented from micros_rtt::ChannelElementBase.
Definition at line 50 of file conn_input_endpoint.hpp.
| virtual FlowStatus micros_rtt::ConnInputEndpoint< M >::read | ( | typename ChannelElement< M >::reference_t | sample | ) | [inline, virtual] |
Reads a new sample from this connection This should never be called, as all connections are supposed to have a data storage element
Definition at line 47 of file conn_input_endpoint.hpp.
Member Data Documentation
ConnectionBasePtr micros_rtt::ConnInputEndpoint< M >::publication_ [private] |
Definition at line 33 of file conn_input_endpoint.hpp.
The documentation for this class was generated from the following file: