Service.hpp

/*
 * (c) Copyright, Real-Time Innovations, 2017.
 * All rights reserved.
 *
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or
 * revisions thereof, must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 */
 
#ifndef RTI_RECORDING_SERVICE_HPP_
#define RTI_RECORDING_SERVICE_HPP_
 
#include <dds/core/Reference.hpp>
#include <rti/config/Logger.hpp>
 
#include <rti/recording/Logger.hpp>
#include <rti/recording/ServiceProperty.hpp>
#include <rti/recording/detail/RecordingServiceImpl.hpp>
 
namespace rti { namespace recording {
 
/*e \defgroup RTI_RecordingServiceLibModule RTI Recording Library API
 *
 * @brief @product  can be deployed as a native library linked into your
 * application in select architectures.
 *
 * This API allows you to create, configure and start @product instances from
 * your application.
 *
 * The following code shows the typical use of the API:
 *
 * \code
 *
 * int main ()
 * {
 *     rti::recording::Service service(
 *             rti::recording::ServiceProperty()
 *             .cfg_file("MyRecorder.xml")
 *             .service_name("MyRecorder"));
 *     ...
 *
 *     service.start();
 *
 *     while(keep_running) {
 *         sleep();
 *         ...
 *     }
 *
 *     return 0;
 * }
 *
 * \endcode
 *
 * Instead of a file, you can use XML strings to configure @product.
 * See ServiceProperty for more information.
 * <p>
 * To build your application you need to link with the @product native library
 * in <b> &lt;@ndds home&gt;/bin/&lt;architecture&gt;/ </b>.
 *
 * ### Development Requirements
 *
 * |                 | Linux Systems                      | Windows Systems           |
 * | --------------: | :----------------:                      | :-------------:           |
 * | Shared Libraries| libnddscpp2.so                          | nddscpp2.dll              |
 * | Shared Libraries| librtiroutingservice.so                 | rtiroutingservice.dll     |
 * | ^               | librtirsinfrastructure.so               | rtirsinfrastructure.dll   |
 * | ^               | librtirecordingservice.so               | rtirecordingservice.dll   |
 * | ^               | librtidlc.so                            | rtidlc.dll                |
 * | ^               | libnddsmetp.so                          | nddsmetp.dll              |
 * | ^               | libnddsc.so                             | nddsc.dll                 |
 * | ^               | librtixml2.so                           | rtixml2.dll               |
 * | ^               | libnddscore.so                          | nddscore.dll              |
 * | Headers         | rti/recording/RecordingService.hpp      ||
 *
 */
 
class Service : public dds::core::Reference<RecordingServiceImpl> {
public:
    typedef RTI::Service::Admin::CommandRequest CommandRequest;
    typedef RTI::Service::Admin::CommandReply CommandReply;
 
    typedef dds::core::Reference<RecordingServiceImpl> Base;
    OMG_DDS_REF_TYPE_NOTYPENAME(
            Service,
            dds::core::Reference,
            RecordingServiceImpl);
 
    explicit Service(const ServiceProperty& property)
            : Base(new RecordingServiceImpl(property))
    {
        this->delegate()->remember_reference(this->delegate());
    }
 
    template <typename HookFunc>
    explicit Service(
            const ServiceProperty& property,
            const HookFunc& shutdown_hook)
            : Base(new RecordingServiceImpl(
                property,
                new rti::routing::detail::ShutdownHookForwarder<HookFunc>(
                        shutdown_hook)))
    {
        this->delegate()->remember_reference(this->delegate());
    }
 
 
    explicit Service(Base::DELEGATE_REF_T reference) : Base(reference)
    {
        if (this->delegate()) {
            this->delegate()->remember_reference(this->delegate());
        }
    }
 
    void start()
    {
        this->delegate()->start();
    }
 
    void stop()
    {
        this->delegate()->stop();
    }
 
 
 
    CommandReply execute_command(const CommandRequest& request)
    {
        return this->delegate()->execute_command(request);
    }
 
    CommandReply& execute_command(
            CommandReply& reply,
            const CommandRequest& request)
    {
        return this->delegate()->execute_command(reply, request);
    }
 
    static void finalize_globals()
    {
        rti::recording::Logger::instance().warn(
                "Calling 'rti::recording::Service::finalize_globals()' is no "
                "longer necessary and the function will be removed in future "
                "versions");
    }
};
 
 
typedef Service RecordingService;
 
}}
 
#endif // RTI_RECORDING_SERVICE_HPP_