RTExternal.h

/*
 * Licensed Materials - Property of HCL and/or IBM
 * Copyright HCL Technologies Ltd. 2016, 2021. All Rights Reserved.
 * Copyright IBM Corporation 1999, 2016. All Rights Reserved.
 *
 * U.S. Government Users Restricted Rights -  Use, duplication or
 * disclosure restricted by GSA ADP Schedule.
 */
 
#ifndef __RTExternal_h__
#define __RTExternal_h__ included
 
#ifdef PRAGMA
#pragma interface
#endif
 
#ifndef __RTInSignal_h__
#include <RTInSignal.h>
#endif
 
#ifndef __RTProtocol_h__
#include <RTProtocol.h>
#endif
 
struct RTExternalData;
 
struct External
{
    class Base : public RTProtocol
    {
    public:
        static const RTProtocolDescriptor rt_class;
 
        RTS_INLINE Base(void);
        ~Base(void);
 
        enum
        {
            rti_event = rtiLast_RTProtocol + 1
        };
 
        void enable(int prio = System);
 
        void disable(void);
 
        int raise(const void * data = nullptr, const RTObject_class * type = nullptr);
 
        void dataPushBack(void* data);
 
        unsigned int dataPopFront(void** data);
 
        unsigned int dataPopBack(void** data);
 
        void dataDelete(void* data);
 
        RTS_INLINE RTInSignal event(void);
 
    protected:
        enum
        {
            rtiLast_External = rti_event
        };
 
    private:
        RTMessage * msg;
 
        RTMessage * unload(void);
 
        static const RTSignalDescriptor rt_signals[];
 
        RTExternalData* externalData;
 
        // unavailable methods
        Base(const Base &);
        Base & operator=(const Base &);
    };
};
 
#if RTS_INLINES
#include <RTExternal.inl>
#endif
 
#endif // __RTExternal_h__