src/core/adapter.cpp

/*******************************************************************************
 * Copyright (c) 2008 - 2015 ACIN, fortiss GmbH, 2018 TU Vienna/ACIN
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *    Ingo Hegny, Alois Zoitl
 *      - initial implementation and rework communication infrastructure
 *    Martin Melik-Merkumians - fixes connect, prepares for working AnyAdapter
 *******************************************************************************/
#include <string.h>
#include "adapter.h"
#ifdef FORTE_ENABLE_GENERATED_SOURCE_CPP
#include "adapter_gen.cpp"
#endif
#include "adapterconn.h"
#include "ecet.h"

CAdapter::CAdapter(CResource *pa_poSrcRes, const SFBInterfaceSpec *pa_pstInterfaceSpecSocket, const CStringDictionary::TStringId pa_nInstanceNameId, const SFBInterfaceSpec *pa_pstInterfaceSpecPlug, bool pa_bIsPlug, TForteByte *pa_acFBConnData, TForteByte *pa_acFBVarsData) :
  CFunctionBlock(pa_poSrcRes, (pa_bIsPlug) ? pa_pstInterfaceSpecPlug : pa_pstInterfaceSpecSocket, pa_nInstanceNameId, pa_acFBConnData, pa_acFBVarsData),
  m_nParentAdapterListEventID(0),
  m_bIsPlug(pa_bIsPlug),
  m_poPeer(0),
  m_aoLocalDIs(m_aoDIs),
  m_poAdapterConn(0){
  setupEventEntryList();
}

CAdapter::~CAdapter(){
  if (m_bIsPlug) {
    if (m_poAdapterConn != 0) {
      delete m_poAdapterConn;
    }
  } else {
    if (m_poAdapterConn != 0) {
      m_poAdapterConn->setSocket(0);
    }
  }
  delete[] m_astEventEntry;
}

void CAdapter::fillEventEntryList(CFunctionBlock* paParentFB){
  for (TForteUInt16 i = 0; i < m_pstInterfaceSpec->m_nNumEOs; ++i) {
    m_astEventEntry[i].mFB = paParentFB;
    m_astEventEntry[i].mPortId = static_cast<TPortId>(m_nParentAdapterListEventID + i);
  }
}

void CAdapter::setParentFB(CFunctionBlock *pa_poParentFB, TForteUInt8 pa_nParentAdapterlistID){
  m_nParentAdapterListEventID = static_cast<TForteUInt16>((pa_nParentAdapterlistID + 1) << 8);

  fillEventEntryList(pa_poParentFB);

  if (isPlug()) {
    //the plug is in charge of managing the adapter connection
    m_poAdapterConn = new CAdapterConnection(this, pa_nParentAdapterlistID, this);
  }
}

bool CAdapter::connect(CAdapter *pa_poPeer, CAdapterConnection *pa_poAdConn){
  bool bRetVal = false;
  if (m_poPeer == 0) {
    m_poPeer = pa_poPeer;
    m_aoDIs = pa_poPeer->m_aoDOs; //TODO: change is adapters of subtypes may be connected
    if (isSocket()) {
      m_poAdapterConn = pa_poAdConn;
    }
    bRetVal = true;
  }

  return bRetVal;
}

bool CAdapter::disconnect(CAdapterConnection *pa_poAdConn){
  if ((pa_poAdConn != 0) && (pa_poAdConn != m_poAdapterConn)) {
    return false; //connection requesting disconnect is not equal to established connection
  }
  m_poPeer = 0;
  m_aoDIs = m_aoLocalDIs;
  if (isSocket()) {
    m_poAdapterConn = 0;
  }
  return true;
}

bool CAdapter::isCompatible(CAdapter *pa_poPeer) const {
  //Need to check any adapter here as we don't know which adapter side is used for checking compatibility
  return ((getFBTypeId() == pa_poPeer->getFBTypeId()) || ((getFBTypeId() == g_nStringIdANY_ADAPTER) && (g_nStringIdANY_ADAPTER != pa_poPeer->getFBTypeId())) || ((getFBTypeId() != g_nStringIdANY_ADAPTER) && (g_nStringIdANY_ADAPTER == pa_poPeer->getFBTypeId())));
}

void CAdapter::executeEvent(int pa_nEIID){
  if (0 != m_poPeer) {
    if (0 != m_poPeer->m_astEventEntry[pa_nEIID].mFB) {
      m_poInvokingExecEnv->addEventEntry(&(m_poPeer->m_astEventEntry[pa_nEIID]));
    } else {
      m_poPeer->m_poInvokingExecEnv = m_poInvokingExecEnv;
      m_poPeer->sendOutputEvent(pa_nEIID);
    }
  }
}

void CAdapter::setupEventEntryList(){
  m_astEventEntry = new SEventEntry[m_pstInterfaceSpec->m_nNumEOs];
}