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/>.

*/

#ifndef URTWARE_CORE_H

#define URTWARE_CORE_H

#include <urtware.h>

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

/* CONSTANTS                                                                  */

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

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

/* SETTINGS                                                                   */

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

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

/* CHECKS                                                                     */

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

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

/* DATA STRUCTURES AND TYPES                                                  */

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

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

/* MACROS                                                                     */

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

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

/* EXTERN DECLARATIONS                                                        */

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

#if defined(__cplusplus)

extern "C" {

#endif /* defined(__cplusplus) */

  void urtCoreInit(void);

  urt_status_t urtCoreGetStatus(void);

  urt_osEventMask_t urtCoreGetEventMask(void);

  urt_osMutex_t* urtCoreGetMutex(void);

  urt_osEventSource_t* urtCoreGetEvtSource(void);

  void urtCoreStartNodes(void);

  urt_status_t urtCoreSynchronizeNodes(urt_node_t* node);

  urt_status_t urtCoreStopNodes(urt_status_t reason);

  urt_node_t* urtCoreGetNodes(void);

  urt_status_t urtCoreAddNode(urt_node_t* node);

#if (URT_CFG_PUBSUB_ENABLED == true)

  urt_status_t urtCoreAddTopic(urt_topic_t* topic);

  urt_topic_t* urtCoreGetTopic(urt_topicid_t id);

#endif /* URT_CFG_PUBSUB_ENABLED */

#if (URT_CFG_RPC_ENABLED == true)

  urt_status_t urtCoreAddService(urt_service_t* service);

  urt_service_t* urtCoreGetService(urt_serviceid_t id);

#endif /* URT_CFG_RPC_ENABLED */

#if (URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true)

  urt_osTimerCallback_t urtCoreCallbackDefault(void* params);

#endif /* URT_CFG_PUBSUB_QOS_DEADLINECHECKS */

#if defined(__cplusplus)

}

#endif /* defined(__cplusplus) */

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

/* INLINE FUNCTIONS                                                           */

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

#endif /* URTWARE_CORE_H */