//Editor-Info: -*- C++ -*-
//
//Subject: TOVE project / SSCOP protocol
//
//File: sscopstate.h
//
//Version: $Revision: 1.13 $
//
//State: $State: Exp $
//
//Date: $Date: 1999/03/11 18:53:55 $
//
//Organisation:
//      Helsinki University of Technology
//      Laboratory of Telecommunications and Multimedia
//
//Author:
//      Juhana Räsänen
//
//Description:
//      Base State class definition for SSCOP state machine
//
//Copyright:
//      Copyright 1999 Helsinki University of Technology
//      ALL RIGHTS RESERVED BETWEEN JANUARY 1996 AND JUNE 1999.
//
//Licence:
//
//
//History:
 

#ifndef __SSCOP_SSCOPSTATE_H__
#define __SSCOP_SSCOPSTATE_H__

#include "sscoppdu.h"
#include "pf/protocol.h"
#include "pf/state.h"
#include "iface/aaif/aadownprimitives.h"
#include "iface/cpcsif/cpcsupprimitives.h"

class sscopProtocol;
class pfTimerMessenger;
class maaUNITDATAreq;
class sscopBGN_PDU;
class sscopBGAK_PDU;
class sscopBGREJ_PDU;
class sscopEND_PDU;
class sscopENDAK_PDU;
class sscopRS_PDU;
class sscopRSAK_PDU;
class sscopER_PDU;
class sscopERAK_PDU;
class sscopSD_PDU;
class sscopPOLL_PDU;
class sscopSTAT_PDU;
class sscopUSTAT_PDU;
class sscopUD_PDU;
class sscopMD_PDU;
class sscopINVALID_PDU;


//
// Class: sscopState
//
// Description:
//     This is the SSCOP state machine base state class. Actual states
//     inherit this class and default actions defined here. SSCOP state
//     itself inherits upward CPCS primitive input methods from an
//     interface class (pfState is also inherited from this class)
//

class sscopState : public pfState,
                   public aaDownInputs,
                   public cpcsUpInputs
{
    public:
// Actions for incoming AA-signals from above layer
        virtual void aaESTABLISHreqAct(aaESTABLISHreq *messenger_,
                                       pfProtocol *protocol_) const;
        virtual void aaESTABLISHrespAct(aaESTABLISHresp *messenger_,
                                        pfProtocol *protocol_) const;
        virtual void aaRELEASEreqAct(aaRELEASEreq *messenger_,
                                     pfProtocol *protocol_) const;
        virtual void aaDATAreqAct(aaDATAreq *messenger_,
                                  pfProtocol *protocol_) const;
        virtual void aaRESYNCreqAct(aaRESYNCreq *messenger_,
                                    pfProtocol *protocol_) const;
        virtual void aaRESYNCrespAct(aaRESYNCresp *messenger_,
                                     pfProtocol *protocol_) const;
        virtual void aaRECOVERrespAct(aaRECOVERresp *messenger_,
                                      pfProtocol *protocol_) const;
        virtual void aaUNITDATAreqAct(aaUNITDATAreq *messenger_,
                                      pfProtocol *protocol_) const;
        virtual void aaRETRIEVEreqAct(aaRETRIEVEreq *messenger_,
                                      pfProtocol *protocol_) const;

// Actions for incoming CPCS-signals from lower layer
        virtual void cpcsUNITDATAindAct(cpcsUNITDATAind *messenger_,
                                        pfProtocol *protocol_) const;

// Actions for incoming MAA-primitives from management plane
        virtual void maaUNITDATAreqAct(maaUNITDATAreq *messenger_,
                                       pfProtocol *protocol_) const;

// Actions for incoming PDUs
        virtual void sscopBGNpduAct(sscopBGN_PDU *messenger_,
                                    sscopProtocol *protocol_) const;
        virtual void sscopBGAKpduAct(sscopBGAK_PDU *messenger_,
                                     sscopProtocol *protocol_) const;
        virtual void sscopBGREJpduAct(sscopBGREJ_PDU *messenger_,
                                      sscopProtocol *protocol_) const;
        virtual void sscopENDpduAct(sscopEND_PDU *messenger_,
                                    sscopProtocol *protocol_) const;
        virtual void sscopENDAKpduAct(sscopENDAK_PDU *messenger_,
                                      sscopProtocol *protocol_) const;
        virtual void sscopRSpduAct(sscopRS_PDU *messenger_,
                                   sscopProtocol *protocol_) const;
        virtual void sscopRSAKpduAct(sscopRSAK_PDU *messenger_,
                                     sscopProtocol *protocol_) const;
        virtual void sscopERpduAct(sscopER_PDU *messenger_,
                                   sscopProtocol *protocol_) const;
        virtual void sscopERAKpduAct(sscopERAK_PDU *messenger_,
                                     sscopProtocol *protocol_) const;
        virtual void sscopSDpduAct(sscopSD_PDU *messenger_,
                                   sscopProtocol *protocol_) const;
        virtual void sscopPOLLpduAct(sscopPOLL_PDU *messenger_,
                                     sscopProtocol *protocol_) const;
        virtual void sscopSTATpduAct(sscopSTAT_PDU *messenger_,
                                     sscopProtocol *protocol_) const;
        virtual void sscopUSTATpduAct(sscopUSTAT_PDU *messenger_,
                                      sscopProtocol *protocol_) const;
        virtual void sscopUDpduAct(sscopUD_PDU *messenger_,
                                   sscopProtocol *protocol_) const;
        virtual void sscopMDpduAct(sscopMD_PDU *messenger_,
                                   sscopProtocol *protocol_) const;
        virtual void sscopINVALIDpduAct(sscopINVALID_PDU *messenger_,
                                        sscopProtocol *protocol_) const;
        
// Actions for timer timeouts
        virtual void sscopCCtimeoutAct(sscopProtocol *protocol_) const;
        virtual void sscopPOLLtimeoutAct(sscopProtocol *protocol_) const;
        virtual void sscopKEEPALIVEtimeoutAct(sscopProtocol *protocol_) const;
        virtual void sscopNORESPONSEtimeoutAct(sscopProtocol *protocol_) const;
        virtual void sscopIDLEtimeoutAct(sscopProtocol *protocol_) const;

// Actions for internal events
        virtual void sscopSDpduQueuedUpAct(sscopProtocol *protocol_) const;
        virtual void sscopUDpduQueuedUpAct(sscopProtocol *protocol_) const;
        virtual void sscopMDpduQueuedUpAct(sscopProtocol *protocol_) const;

    protected:
        sscopState(void);
        virtual ~sscopState(void);
};


#endif // __SSCOP_SSCOPSTATE_H__