clmessage.h

Go to the documentation of this file.

/* -*- Mode:C++ -*- /*
/*
 * Copyright (c) 2006 Regents of the SIGNET lab, University of Padova.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University of Padova (SIGNET lab) nor the 
 *    names of its contributors may be used to endorse or promote products 
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _COMMONCLMSG_
#define _COMMONCLMSG_

#include <string.h>
#include <scheduler.h>

#define MAX_MODULE_TAG 6
//NOT USED ... #define MAX_CR_LAY_TAG 8                 // size in character of the exchanged string in cross-layer command
#define INVALID_DESTINATION -1
//NOT USED.. #define ALL_LEVEL 0                                        // broadcasr address for cross-layer messages directed to all layers
#define NO_MODULE -1


#define CLBROADCASTADDR -1



#define CLPLUGINLAYERNUM 0

enum DestinationType{
        UNICAST,
        BROADCAST
};
enum ClDirection{
        TONODECORE,
        TOMODULE,
        UP,
        DOWN
};
typedef unsigned int ClMessage_t;

/*
 * the father class of all cross layer messages
*/
class ClMessage : public Event{
public:
        ClMessage(int verbosity, ClMessage_t type);

        ClMessage(ClMessage *m);


        ClMessage(int verbosity, ClMessage_t type, DestinationType dtype, int value);

        virtual ~ClMessage();

        DestinationType getDestType();

        int getDest();

        int getSource();

        void setSource(int src);

        void setDest(int dst);


        virtual ClMessage *copy();

        int verbosity();

        ClMessage_t type();

        ClDirection direction();

        void direction(ClDirection dir);

        unsigned int uid();

        static ClMessage_t addClMessage();

protected:
        static ClMessage_t nType_;

        ClMessage_t type_;

        DestinationType destType_;

        int source_;

        int dest_;

        int verbosity_;

        ClDirection direction_;

        unsigned int uid_;









  /******************************
   * Deprecated Methods
   * 
   */

public:
        ClMessage(int verbosity, ClMessage_t type, DestinationType dtype, int source, int value);

};

#endif

---