• Overview
  • Examples
  • HowTos
  • Glossary
    • Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
    senf::ppi::connector::Connector Class Reference

    Connector base-class. More...

    #include <senf/PPI/Connectors.hh>

    Inheritance diagram for senf::ppi::connector::Connector:
    Inheritance graph
    [legend]

    Public Types

    enum  TraceState { NO_TRACING, TRACE_IDS, TRACE_CONTENTS }
     

    Public Member Functions

    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
     

    Static Public Member Functions

    static void staticTracingState (TraceState state)
     
    static void tracingFilter (std::string const &traceFilter)
     

    Protected Member Functions

     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 ()
     
    virtual void v_disconnected ()
     
    virtual void v_connected ()
     

    Detailed Description

    Connector base-class.

    This connector provides access to the generic connector facilities. This includes the connection management (access to the connected peer) and the containment management (access to the containing module)

    Definition at line 156 of file Connectors.hh.

    Member Enumeration Documentation

    ◆ TraceState

    enum senf::ppi::connector::Connector::TraceState
    Enumerator
    NO_TRACING 
    TRACE_IDS 
    TRACE_CONTENTS 

    Definition at line 172 of file Connectors.hh.

    Constructor & Destructor Documentation

    ◆ Connector()

    senf::ppi::connector::Connector::Connector ( )
    		protected

    Definition at line 31 of file Connectors.cc.

    ◆ ~Connector()

    senf::ppi::connector::Connector::~Connector ( )
    		protectedvirtual

    Definition at line 47 of file Connectors.cc.

    Member Function Documentation

    ◆ connect()

    void senf::ppi::connector::Connector::connect ( Connector &  target)
    		protected

    Definition at line 58 of file Connectors.cc.

    ◆ connected()

    bool senf::ppi::connector::Connector::connected ( ) const

    true, if connector connected, false otherwise

    ◆ consoleDir()

    console::DirectoryNode& senf::ppi::connector::Connector::consoleDir ( ) const

    ◆ disconnect()

    void senf::ppi::connector::Connector::disconnect ( )

    Disconnect connector from peer.

    Definition at line 206 of file Connectors.cc.

    ◆ module()

    senf::ppi::module::Module & senf::ppi::connector::Connector::module ( ) const

    Get this connectors containing module.

    Definition at line 242 of file Connectors.cc.

    ◆ peer()

    Connector& senf::ppi::connector::Connector::peer ( ) const

    Get peer connected to this connector.

    ◆ staticTracingState()

    static void senf::ppi::connector::Connector::staticTracingState ( TraceState  state)
    		static

    ◆ throttleTrace()

    void senf::ppi::connector::Connector::throttleTrace ( char const *  label,
    char const *  type 
    )
    		protected

    Definition at line 134 of file Connectors.cc.

    ◆ trace()

    void senf::ppi::connector::Connector::trace ( Packet const &  p,
    char const *  label 
    )
    		protected

    Definition at line 110 of file Connectors.cc.

    ◆ tracingFilter()

    static void senf::ppi::connector::Connector::tracingFilter ( std::string const &  traceFilter)
    		static

    ◆ tracingState() [1/2]

    void senf::ppi::connector::Connector::tracingState ( TraceState  state)

    ◆ tracingState() [2/2]

    TraceState senf::ppi::connector::Connector::tracingState ( ) const

    ◆ unregisterConnector()

    void senf::ppi::connector::Connector::unregisterConnector ( )
    		protected

    Definition at line 229 of file Connectors.cc.

    ◆ v_connected()

    void senf::ppi::connector::Connector::v_connected ( )
    		protectedvirtual

    Reimplemented in senf::ppi::connector::GenericActiveOutput, senf::ppi::connector::GenericActiveInput, senf::ppi::connector::GenericPassiveOutput, senf::ppi::connector::GenericPassiveInput, senf::ppi::connector::OutputConnector, senf::ppi::connector::InputConnector, senf::ppi::connector::ActiveConnector, and senf::ppi::connector::PassiveConnector.

    Definition at line 256 of file Connectors.cc.

    ◆ v_disconnected()

    void senf::ppi::connector::Connector::v_disconnected ( )
    		protectedvirtual

    Reimplemented in senf::ppi::connector::GenericActiveOutput, senf::ppi::connector::GenericActiveInput, senf::ppi::connector::GenericPassiveOutput, senf::ppi::connector::GenericPassiveInput, senf::ppi::connector::OutputConnector, senf::ppi::connector::InputConnector, senf::ppi::connector::ActiveConnector, and senf::ppi::connector::PassiveConnector.

    Definition at line 251 of file Connectors.cc.

    The documentation for this class was generated from the following files: