Example Demo Interface Binding

Table of Contents

• Description
• Prebuilt Binaries
• Source Code
  • Interface
  • Client
  • Server
  • Plugin

Description

Shows how to share functionality between filters.

Prebuilt Binaries

• Demo Interface Binding Client
• Demo Interface Binding Server

Source Code

./examples/demo_adtfplugins/demo_interface_binding/

Interface

print_intf.h

 
#pragma once
#include <adtf_utils.h>
#include <adtfucom3/adtf_ucom3.h>
 
// this is the example interface that is shared via interface binding
class IPrintInterface : public adtf::ucom::IObject
{
    public:
        ADTF_IID(IPrintInterface, "demo_print_interface.demo.adtf.iid");
 
    public:
        virtual void Print(const char* strString) = 0;
};

class cPrinter : public adtf::ucom::object<IPrintInterface>
{
public:
    void Print(const char* strString) override
    {
        LOG_INFO("%s", strString);
    }
};
 

Client

demo_interface_binding_client_filter.h

 
#pragma once
#include <print_intf.h>
 
#include <adtffiltersdk/adtf_filtersdk.h>
 
#ifndef ADTF_EXAMPLES_CID
#define ADTF_EXAMPLES_CID ".local.cid"
#endif
 
// define a trigger function
class cInterfaceBindingClientFilter final : public adtf::filter::cFilter
{
    public:
        ADTF_CLASS_ID_NAME(cInterfaceBindingClientFilter,
                           "demo_interface_binding.filter" ADTF_EXAMPLES_CID,
                           "Demo Interface Binding Client");
 
        cInterfaceBindingClientFilter();
        ~cInterfaceBindingClientFilter() override;
 
        tResult Process(adtf::base::tNanoSeconds tmTimeOfTrigger,
                        adtf::streaming::IRunner* pRunner) override;
 
    private:
        adtf::filter::interface_client<IPrintInterface> m_oInterfaceClient;
};

demo_interface_binding_client_filter.cpp

 
#include "demo_interface_binding_client_filter.h"
#include <cinttypes>
 
using namespace adtf::util;
using namespace adtf::ucom;
using namespace adtf::base;
using namespace adtf::streaming;
using namespace adtf::filter;
 
cInterfaceBindingClientFilter::cInterfaceBindingClientFilter()
{
    m_oInterfaceClient = CreateInterfaceClient<IPrintInterface>("printer_client");
    SetDescription("printer_client", "Interface client to call a printer function from a server");
 
    CreateRunner("trigger", cTimerTriggerHint(std::chrono::seconds{1}));
    SetDescription("trigger", "Runner to periodically trigger the function which prints the timestamp of the trigger");
 
    // sets a short description for the component
    SetDescription("Use this filter to provide a client which accesses the printer interface from Demo Interface Printer (see Streaming Sources).");
 
    // set help link to jump to documentation from ADTF Configuration Editor
    SetHelpLink("$(ADTF_DIR)/doc/html/page_demo_interface_binding_client.html");
}
 
cInterfaceBindingClientFilter::~cInterfaceBindingClientFilter() = default;
 
tResult cInterfaceBindingClientFilter::Process(tNanoSeconds tmTimeOfTrigger, IRunner * /*pRunner*/)
{
    m_oInterfaceClient->Print(cString::Format("time is %" PRIi64, tmTimeOfTrigger.nCount));
    RETURN_NOERROR;
}

Server

demo_interface_binding_server_filter.h

 
#pragma once
#include <print_intf.h>
#include <adtffiltersdk/adtf_filtersdk.h>
 
#ifndef ADTF_EXAMPLES_CID
#define ADTF_EXAMPLES_CID ".local.cid"
#endif
 
class cInterfaceBindingServerFilter final : public adtf::filter::cFilter
{
    public:
        ADTF_CLASS_ID_NAME(cInterfaceBindingServerFilter,
                           "demo_interface_binding_server.filter" ADTF_EXAMPLES_CID,
                           "Demo Interface Binding Server");
 
        cInterfaceBindingServerFilter();
        ~cInterfaceBindingServerFilter() override;
 
    private:
        // this is our exppose server object
        adtf::ucom::object_ptr<IPrintInterface> m_pPrinter;
};

demo_interface_binding_server_filter.cpp

 
#include "demo_interface_binding_server_filter.h"
 
using namespace adtf::util;
using namespace adtf::ucom;
using namespace adtf::base;
using namespace adtf::streaming;
using namespace adtf::filter;
 
cInterfaceBindingServerFilter::cInterfaceBindingServerFilter()
{
    m_pPrinter = make_object_ptr<cPrinter>();
    CreateInterfaceServer<IPrintInterface>("printer_server", m_pPrinter);
    SetDescription("printer_server", "Interface server to provide access to a function for printing");
 
    // sets a short description for the component
    SetDescription("Use this filter to provide a server for a printer Interface (e.g. used by 'Demo Interface Binding Client', see Filters");
 
    // set help link to jump to documentation from ADTF Configuration Editor
    SetHelpLink("$(ADTF_DIR)/doc/html/page_demo_interface_binding_server.html");
}
 
cInterfaceBindingServerFilter::~cInterfaceBindingServerFilter() = default;

Plugin

plugin.cpp

 
#include "demo_string_sending_filter.h"
#include "demo_string_receiving_filter.h"

ADTF_PLUGIN("Demo String Handling Filters Plugin",
            cDemoStringSending,
            cDemoStringReceiving);