entryinfo.hh

Go to the documentation of this file.

#ifndef _DRAMA2_ENTRYINFO_INC
#define _DRAMA2_ENTRYINFO_INC
 
/*
 * History:
     09-Jan-2014 - TJF - Original version
 
 * The above ID is for Doxygen, this one has the format ACMM is looking for.
 * "@(#) $Id$"
 */
 
 
#include "DitsSystem.h"
#include "DitsInteraction.h"            /* For DitsTaskFromPath         */
#include "drama/sds.hh"
 
namespace drama { 
 
    enum class EntryCode { 
        /*
         * Entry codes equivalent to DRAMA Entry reasons.
         */
        Obey=DITS_REA_OBEY,                        
        Kick=DITS_REA_KICK,                        
        Resched=DITS_REA_RESCHED,                  
        Timeout=DITS_REA_RESCHED,                  
        Trigger=DITS_REA_TRIGGER,                  
        Signal=DITS_REA_ASTINT,                    
        Load=DITS_REA_LOAD,                        
        LoadFailed=DITS_REA_LOADFAILED,            
        Rejected=DITS_REA_MESREJECTED,             
        Complete=DITS_REA_COMPLETE,                
        Died=DITS_REA_DIED,                        
        PathFound=DITS_REA_PATHFOUND,              
        PathFailed=DITS_REA_PATHFAILED,            
        Message=DITS_REA_MESSAGE,                  
        Error=DITS_REA_ERROR,                      
        Exit=DITS_REA_EXIT,                        
        Notify=DITS_REA_NOTIFY,                    
        BulkTransferred=DITS_REA_BULK_TRANSFERRED, 
        BulkDone=DITS_REA_BULK_DONE,                           
        Drama2Signal=DITS_REA_DRAMA2,                           
        /*
         * Extra entry codes used internally
         *  1111 is well out of the range used by the DRAMA entry
         *        reasons, so that is our base.
         */
 
        DramaRunLoopExit=1111,        // Task::RunDrama exited returned.
        DramaMainThreadComplete=1112, // Action thread completed.
        DramaAbortWaits=1113          // Intentional abort of waits.
       };  
 
    class EntryInfo {
    private:
        Dits___CurMessType _info;
        unsigned long _sequence=0;
        long _actionPtr=-1;
        DitsPathType _path = nullptr;
 
    public:
        EntryInfo()  {}
        
        void SetFromDits() {
            /*
             * Note-  does not handle DYNAMIC allocation of DITS Global
             * data, but that only happens on VxWorks and we don't support
             * VxWorks.  Should get a compiler error here in such cases, but
             * we force is by ensuring 
             */
#ifdef DITS_TASKDYNAMIC
            static_assert(0, "DRAMA 2 does not (yet) support dynamic DITS Global items");
#endif
            _info = DitsCurrent.Mess;
            _actionPtr = DitsCurrent.actionptr;
            if (_actionPtr >= 0)
                _sequence = DitsActions[DitsCurrent.actionptr].seq;
            else
                _sequence = 0;
 
            _path = DitsGetEntPath();
        }
 
        sds::Id Argument() const {
            return sds::Id::CreateFromSdsIdType(_info.argin);
        }
        StatusType Status() const {
            return _info.reasonstat;
        }
        EntryCode Reason() const {
            return static_cast<EntryCode>(_info.reason);
        }
 
        std::string EntryName() const {
            return _info.name.n;
        }
        bool Complete() const {
            return static_cast<bool>(_info.complete);
        }
        std::string LoadErrText() const {
            if ((Reason() ==  EntryCode::LoadFailed)||
                (Reason() ==  EntryCode::LoadFailed))
                return _info.sysErrText;
            else
                return "";
        }
        long int LoadErrorStatus() const {
            return _info.sysSysStat;
        }
 
        DitsTransIdType EntryTransId() const {
            return (DitsTransIdType)(_info.transid);
        }
        unsigned long Sequence() const {
            return _sequence;
        }
        DitsBulkInfoType GetBulkInfo() const {
            return _info.bulkTransferInfo;
        }
 
        DitsPathType EntryPath() const {
            return _path;
        }
        std::string EntryTaskName() const {
            if (_path)
            {
                char taskname[DITS_C_NAMELEN];
                StatusType status = STATUS__OK;
                DitsTaskFromPath(_path,sizeof(taskname),taskname,&status);
                if (status == STATUS__OK)
                    return taskname;
                 DramaTHROW(status, "Failure getting task name for entry path");
            }
            return "";
        }
 
        bool ArgIsBulk() const {
            return _info.bulkArgRelease ? true : false;
        }
 
    };
 
} // namespace drama
 
#endif