AMiRo-OS

/*

µRtWare is a lightweight publish/subscribe middleware for real-time

applications. It was developed as part of the software habitat for the

Autonomous Mini Robot [1] (AMiRo) but can be used for other purposes as well.

Copyright (C) 2018..2020  Thomas Schöpping et al.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#include <urtware.h>

/******************************************************************************/

/* LOCAL DEFINITIONS                                                          */

/******************************************************************************/

/******************************************************************************/

/* EXPORTED VARIABLES                                                         */

/******************************************************************************/

/******************************************************************************/

/* LOCAL TYPES                                                                */

/******************************************************************************/

/******************************************************************************/

/* LOCAL VARIABLES                                                            */

/******************************************************************************/

/******************************************************************************/

/* LOCAL FUNCTIONS                                                            */

/******************************************************************************/

/******************************************************************************/

/* EXPORTED FUNCTIONS                                                         */

/******************************************************************************/

/**

 * @brief   Initialize the nrt Subscriber.

 *

 * @param[in] subscriber  The NRT subscriber to initialize. Must not be NULL.

 */

void urtNrtSubscriberInit (urt_nrtsubscriber_t* subscriber)

{

  urtDebugAssert(subscriber);

  subscriber->base.topic = NULL;

  urtEventListenerInit(subscriber->base.evtListener);

  subscriber->base.lastMessage = NULL;

  subscriber->base.lastMessageTime = 0;

#if (URT_CFG_PUBSUB_PROFILING == true)

    subscriber->minLatency = URT_DELAY_INFINITE;

    subscriber->maxLatency = URT_DELAY_IMMEDIATE;

#endif /* URT_CFG_PUBSUB_PROFILING */

  return;

}

/**

 * @brief  Subscribes the subscriber to a topic.

 *

 * @param[in] subscriber  The NRT subscriber which shall subscribe to a topic. Must not be NULL.

 * @param[in] topic  The topic to subscribe to. Must not be NULL.

 * @param[in] messages  NULL terminated list of messages to contribute to the topic.

 *                      Messages must not be associated to another topic.

 *                      Once a message has been contributed, it cannot be removed later.

 *                      May be NULL(no messages to contribute).

 *

 * @return  Returns URT_STATUS_OK on success.

 *          Returns URT_STATUS_SUBSCRIBE_TOPICSET if the subscriber is already associated to a topic.

 */

urt_status_t urtNrtSubscriberSubscribe (urt_nrtsubscriber_t* subscriber, urt_topic_t* topic, urt_message_t* messages)

{

  urtDebugAssert(subscriber);

  urtDebugAssert(topic);

  if (!subscriber->base.topic)

      return URT_STATUS_SUBSCRIBE_TOPICSET;

  subscriber->base.topic = topic;

  //TODO: Lock topic

  if (messages)

  {

    urt_message_t* lastMessageContribute = messages;

    while (lastMessageContribute->next)

    {

        lastMessageContribute = lastMessageContribute->next;

    }

    lastMessageContribute->next = topic->latestMessage->next;

    topic->latestMessage->next = messages;

  }

  subscriber->base.lastMessage = topic->latestMessage;

  subscriber->base.lastMessageTime = topic->latestMessage->originTime;

  urtEventRegister(topic->evtSource, subscriber->base.evtListener, URT_EVENTMASK_MAXPRIO, URT_EVENTFLAG_PROCEED); //TODO: Correct mask, flag?

#if (URT_CFG_PUBSUB_PROFILING == true)

    topic->numHrtSubscribers--;

#endif /* URT_CFG_PUBSUB_PROFILING */

  //TODO: Unlock topic

  return URT_STATUS_OK;

}

/**

 * @brief  Fetches the next message.

 *

 * @param[in] subscriber  The NRT subscriber that shall fetch the message. Must not be NULL.

 * @param[in] payload  Pointer where to copy the payload to. May be NULL for messages without payload.

 * @param[in] bytes  Payload size in bytes.

 * @param[in] latency  The latency can be returned by reference. May be NULL.

 *

 * @return  Returns URT_STATUS_OK on success.

 *          Returns URT_STATUS_FETCH_NOTOPIC if the subscriber is not associated to a topic.

 *          Retruns URT_STATUS_FETCH_NOMESSAGE if there is no new message to fetch.

 */

urt_status_t urtNrtSubscriberFetchNextMessage (urt_nrtsubscriber_t* subscriber, void* payload, size_t bytes, urt_delay_t* latency)

{

  urtDebugAssert(subscriber);

  return URT_STATUS_OK;

}

/**

 * @brief Fetches the latest message.

 *

 * @param[in] subscriber  The NRT subscriber that shall fetch the message. Must not be NULL.

 * @param[in] payload  Pointer where to copy the payload to. May be NULL for messages without payload.

 * @param[in] bytes  Payload size in bytes.

 * @param[in] latency  The latency can be returned by reference. May be NULL.

 *

 * @return  Returns URT_STATUS_OK on success.

 *          Returns URT_STATUS_FETCH_NOTOPIC if the subscriber is not associated to a topic.

 *          Returns URT_STATUS_FETCH_NOMESSAGE if there is no new message to fetch.

 */

urt_status_t urtNrtSubscriberFetchLatestMessage (urt_nrtsubscriber_t* subscriber, void* payload, size_t bytes, urt_delay_t* latency) {

  return URT_STATUS_OK;

}

/**

 * @brief  Unsubscribes from a subscriber.

 *

 * @param[in] subscriber  The NRT subscriber to be unsubscribed. Must not be NULL.

 *

 * @return  Returns URT_STATUS_OK on sucess.

 *          Returns URT_STATUS_UNSUBSCRIBE_NOTOPIC if the subscriber is not associated to a topic.

 */

urt_status_t urtNrtSubscriberUnsubscribe (urt_nrtsubscriber_t* subscriber)

{

  if (subscriber->base.topic)

  {

# if(URT_CFG_PUBSUB_PROFILING == true)

      //TODO: LOCK TOPIC

      subscriber->base.topic->numSubscribers--;

# endif /* URT_CFG_PUBSUB_PROFILING */

    urtEventUnregister(subscriber->base.topic->evtSource, subscriber->base.evtListener);

# if(URT_CFG_PUBSUB_PROFILING == true)

      //TODO: Unlock TOPIC

      subscriber->base.topic = NULL;

      subscriber->base.lastMessage = NULL;

      subscriber->base.lastMessageTime = 0;

#endif /* URT_CFG_PUBSUB_PROFILING */

    return URT_STATUS_OK;

  }

  return URT_STATUS_UNSUBSCRIBE_NOTOPIC;

}

/**

 * @brief  Initialize the srt Subscriber.

 *

 * @param[in] subscriber  The SRT subscriber to initialize. Must not be NULL.

 */

void urtSrtSubscriberInit(urt_srtsubscriber_t* subscriber)

{

  urtDebugAssert(subscriber);

  subscriber->base.topic = NULL;

  urtEventListenerInit(subscriber->base.evtListener);

  subscriber->base.lastMessage = NULL;

  subscriber->base.lastMessageTime = 0;

  #if (URT_CFG_PUBSUB_PROFILING)

    subscriber->base.sumLatencies = 0;

    subscriber->base.numMessagesReceived = 0;

    subscriber->usefulnesscb = NULL;

    subscriber->cbparams = NULL;

    subscriber->minLatency = URT_DELAY_INFINITE;

    subscriber->maxLatency = URT_DELAY_IMMEDIATE;

  #endif /* URT_CFG_PUBSUB_PROFILING */

  return;

}

/**

 * @brief  Subscribes the subscriber to a topic.

 *

 * @param[in] subscriber  The SRT subscriber which shall subscribe to a topic. Must not be NULL.

 * @param[in] topic  The topic to subscribe to. Must not be NULL.

 * @param[in] message  NULL terminated list of messages to contribute to the topic.

 *                     Messages must not be associated to another topic.

 *                     Once a message has been contributed, it cannot be removed later.

 *                     May be NULL (no messages to contribute)

 * @param[in] us