void CustomIO::ProtocolImplementation()
{
  ...
  if(!IsOutputDisabled())
    SendOutputs();
  ReceiveInputs();
  ...
}

Member Function Documentation

IOServer::IOServer()

Constructs an IOServer.

The member sendOnPropertyChangeImplementer is created from "new ServerIO::TSendOnPropertyChangeSupport<CDPBaseObject,CDPPropertyBase,IOServer>(this)".

The member messageTriggeringImplementer is created from "new ServerIO::MessageTriggeringSupport<CDPConnector, IOServer>(this)".

[virtual] IOServer::~IOServer()

IOServer destructor, deletes sendOnPropertyChangeImplementer.

[override virtual] void IOServer::Activate()

Reimplemented from CDPBaseObject::Activate().

Activates the IOServer, starts message processing and periodic process execution.

The CDPSignal NumberOfNodes is initialized with value from function NumberOfNodesInXml().

[override virtual] void IOServer::ActivateIfWaitingForActivate()

Reimplemented from CDPObject::ActivateIfWaitingForActivate().

If activate time has been reached, the IOServer is activated.

[override virtual] void IOServer::Configure(const char *componentXML)

Reimplemented from CDPObject::Configure().

Configure this IOServer from xml.

[virtual] void IOServer::ConfigureChannel(XMLElementEx *channelConfig)

Creates an i/o signal from channelConfig.

[virtual] void IOServer::ConfigureNode(XMLElementEx *nodeConfig)

Configures all the modules in one node for this IOServer from nodeConfig.

[override virtual] void IOServer::Create(const char *fullName)

Reimplemented from CDPComponent::Create().

Creates an IOServer. requestedState is initialized to "Offline".

[override virtual] void IOServer::CreateModel()

Reimplemented from CDPBaseObject::CreateModel().

Creates model for IOServer. Registers initial states and transitions.

The IOServer base-class REQUIRES these states:

Online: Switches to Offline state. Offline: Switches to Online state.

The IOServer base-class REQUIRES these transitions:

Null: initial state, statetransition TransitionNullToOffline. Offline: checks if we can go Online, statetransition TransitionOnlineToOffline. Online: checks if we must go to Offline, statetransition TransitionOfflineToOnline.

void IOServer::DeregisterOnRecieveMessage(const std::string &relativePacketURI)

Deregisters a packet from triggering a message sending.

The function is symmetric opposite to RegisterOnRecieveMessage().

void IOServer::DeregisterSendOnChange(ServerIO::ISendOnPropertyChange &packet, const char *propertyTracker = nullptr, ICDPNode *contextNode = nullptr)

Deregisters a packet from listening for trackedProperty. Must be called before packet is deleted.

When the propertyTracker and contextNode is nullptr, the default property link is removed.

void IOServer::DeregisterSendOnMessage(const std::string &relativePacketURI)

Deregisters a packet from message based triggering.

The function is symmetric opposite to RegisterSendOnMessage().

[override virtual] void IOServer::Destroy()

Reimplemented from CDPBaseObject::Destroy().

Destroys this IOServer.

[virtual] double *IOServer::GetChannel(const char *fullName)

Currently not implemented, will just return nullptr.

double IOServer::GetSendOnChangeTimer()

Get timer interval used for default periodic send on change property.

[protected] int IOServer::HandleIOTrigger(const MessagePacketHandle &handle)

[override virtual] bool IOServer::HandleXMLElement(XMLElementEx *pEx)

Reimplemented from CDPComponent::HandleXMLElement().

HandleXMLElement() handles XMLElement-names "Channel" and "Node", otherwise calls CDPComponent::HandleXMLElement(pEx).

If XMLElement-name (pEx->GetName()) is "Channel", true is returned. If XMLElement-name is "Node", ConfigureNode(pEx) is called before true is returned. Otherwise, value from CDPComponent::HandleXMLElement(pEx) is returned.

[pure virtual] bool IOServer::IsCommProblem()

Should return true if there is a communication-problem/lost contact with one or several nodes, false if not.

Must be implemented in classes inheriting IOServer.

[virtual] bool IOServer::IsOutputDisabled(void)

Returns value from CDPSignal outputDisabled.

[override virtual] bool IOServer::IsReadyToActivate()

[virtual] unsigned int IOServer::NumberOfNodesInXml() const

This function just returns 1.

Overridden version should return number of nodes which the I/O Server configuration specifies. Must be overridden in classes inheriting IOServer, if receiving from more than 1 node.

[virtual] unsigned int IOServer::NumberOfNodesOnline()

This function returns 1 as long as state is Online, 0 is returned otherwise.

Overridden version should return number of nodes online (receiving from, not timedout, and possibly nodestatus OK (if available)). Must be overridden in classes inheriting IOServer, if receiving from more than 1 node.

[override virtual] void IOServer::ProcessNull()

Reimplemented from CDPComponent::ProcessNull().

Process method for Null state.

The CDPSignal NumberOfNodesOnline is updated with value from function NumberOfNodesOnline().

[virtual] void IOServer::ProcessOffline()

Process-function for Offline state.

Calls sendOnPropertyChangeImplementer->ProcessSendOnChangeRequests(). If IsCommProblem() returns false, "Online" state is requested, SignalTimeoutTimer is restarted and Transmission Error alarm is cleared if it was set. If IsCommProblem() returns true, Transmission Error alarm is set if SignalTimeoutTimer has timed out. The CDPSignal NumberOfNodesOnline is updated with value from function NumberOfNodesOnline().

[virtual] void IOServer::ProcessOnline()

Process-function for Online state.

Calls sendOnPropertyChangeImplementer->ProcessSendOnChangeRequests(). If IsCommProblem() returns true, "Offline" state is requested, and Transmission Error alarm is set if SignalTimeoutTimer has timed out. If IsCommProblem() returns false, SignalTimeoutTimer is restarted and Transmission Error alarm is cleared if it was set. The CDPSignal NumberOfNodesOnline is updated with value from function NumberOfNodesOnline().

void IOServer::PropertyChangeCallback(CDPPropertyBase *property)

Is called by all the properties on target change to handle send flag setting by IOServer on ISendOnPropertyChange implementers.

The input properties are created by the IOServer to listen to external properties.

void IOServer::RegisterOnRecieveMessage(const std::string &targetRouting, const std::string &relativePacketURI)

Registers a packet to trigger the sending of IOTrigger text command message on packet reception.

The function is intended to be used by IOServers that need to implement Message sending on receive packets.

The function is used with MessageTriggeringSupport::TriggerMessage() that implements ITriggerMessage interface. The MessageTriggeringSupport pointer should be passed into the packet as ITriggerMessage pointer and TriggerMessage() called when the packet is received.

targetRouting should contain routing to Object that Handles the IOTrigger messages for the packet. relativePacketURI should contain relative packet routing in the IOServer in question. Incoming event on this packet will trigger corresponding text command message to be sent to targetRouting when packet receive code calls MessageTriggeringSupport::TriggerMessage() with packets relativePacketURI.

void IOServer::RegisterSendOnChange(ServerIO::ISendOnPropertyChange &packet, const char *propertyRouting = nullptr, ICDPNode *contextNode = nullptr)

Registers a packet to be flagged to be sent on property change.

When propertyRouting is provided, the routed property should be of bool type. The packet's FlagForSend() is called each time the routed property has an edge (change from true to false or from false to true). When propertyRouting is not provided, the packet will be sent at the owning components period.

The propertyRouting must either be a full URI or if relative routing support is required, the optional contextNode argument must be passed in. The contextNode is the node containing the propertyRouting value.

See also ServerIO::ICDPChannel::RegisterValidator().

void IOServer::RegisterSendOnChangeWakeCall(ServerIO::IWakeFunctor *waker)

Setting the IWakeFunctor for the IOServer worker thread.

If IOServer Main thread uses a CDPEvent or OSAPIPeriodicTimer to wait on thread the RegisterSendOnChangeWakeCall may be used to register a Functor that wakes up the specific event or timer from wait. The IOServer implementation should then create a wake functor with the waiting class OSAPIPeriodicTimer for ex. and register it.

struct IOWorkerFunctor : public ServerIO::IWakeFunctor
{
  IOWorkerFunctor(OSAPIPeriodicTimer* t)
  {
    wakeable=t;
  }
  void operator()()
  {
    if (wakable) wakable->SetEvent();
  }
  private:
  OSAPIPeriodicTimer* wakeable;
};

See also ServerIO::ICDPChannel::RegisterValidator().

void IOServer::RegisterSendOnMessage(ServerIO::ISendTrigger &packet, const std::string &relativePacketURI)

Registers a packet to be flagged to be sent on IOTrigger text command message.

The function is intended to be used by IOServers that need to implement Message based triggering for transmit packets.

packet to be registered for send on message behaviour relativePacketURI is packets relative URI in the IOServer

The IOTrigger message must be sent with CDPConnector, that is connected to the IOServer component containing the packet, using additional parameter indicating relative URI of the packet in IOServer component. Optionally the parameter may contain semicolon separated key value pairs to override packet channel values for triggered packet.

The packet triggering with CDPConnector from user component code would look as follows:

connector.SendMessage(ServerIO::IOTrigger, ".MyNode.TPDO1;Speed=20");

void IOServer::RegisterSendOnMessageWakeCall(ServerIO::IWakeFunctor *waker)

Setting the IWakeFunctor for the IOServer worker thread for IOTrigger message wakeup.

If IOServer Main thread uses a CDPEvent or OSAPIPeriodicTimer to wait on thread the RegisterSendOnMessageWakeCall may be used to register a Functor that wakes up the specific event or timer from wait. The IOServer implementation should then create a wake functor with the waiting class OSAPIPeriodicTimer for ex. and register it.

struct IOWorkerFunctor : public ServerIO::IWakeFunctor
{
  IOWorkerFunctor(OSAPIPeriodicTimer* t)
  {
    wakeable=t;
  }
  void operator()() override
  {
    if (wakable) wakable->SetEvent();
  }
  private:
  OSAPIPeriodicTimer* wakeable;
};

void IOServer::SetSendOnChangeTimer(double interval)

Set timer interval used for default periodic send on change property.

[virtual] bool IOServer::TransitionNullToOffline()

Returns true if requestedState is equal to "Offline".

[virtual] bool IOServer::TransitionOfflineToOnline()

Returns true if requestedState is equal to "Online".

[virtual] bool IOServer::TransitionOnlineToOffline()

Returns true if requestedState is equal to "Offline".