BroadcastComms.h

Go to the documentation of this file.

#include "roneos.h"
#ifndef BROADCASTCOMMS_H_
#define BROADCASTCOMMS_H_

// the maximum number of hops for any broadcast message
#define BROADCAST_MSG_HOPS_MAX                  15

// message time to live.  Defined in rounds
#define BROADCAST_MSG_MAX_TIMEOUT               4 

typedef struct BroadcastMessage {
        boolean active;                         
        uint8 senderID;                         
        uint32 messageUpdateRound;      
        boolean isSource;                       
        uint8 hopsMax;                          
        uint8 inactiveTimeOut;          
        uint32 timeToUpdateRound;       
        NbrData msgSourceID;            
        NbrData msgHops;                        
        NbrData msgTimestamp;           
} BroadcastMessage;


void broadcastMsgCreate(BroadcastMessage* msgPtr, uint8 maxHops);

void broadcastMsgUpdateNav(BroadcastMessage* msgPtr, NbrList* nbrListPtr);


void broadcastMsgClear(BroadcastMessage* msgPtr);


void broadcastMsgSetSource(BroadcastMessage* msgPtr, boolean val);

boolean broadcastMsgIsSource(BroadcastMessage* msgPtr);


void broadcastMsgUpdate(BroadcastMessage* msgPtr, NbrList* nbrListPtr);


void broadcastMsgUpdateLeaderElection(BroadcastMessage* msgPtr, NbrList* nbrListPtr);


void broadcastMsgUpdateNbrData(BroadcastMessage* msgPtr, NbrData* nbrDataPtr);


uint8 broadcastMsgGetHops(BroadcastMessage* msgPtr);


uint8 broadcastMsgGetHopsNbr(BroadcastMessage* msgPtr, Nbr* nbrPtr);


uint8 broadcastMsgGetSourceID(BroadcastMessage* msgPtr);


uint8 broadcastMsgGetSourceIDNbr(BroadcastMessage* msgPtr, Nbr* nbrPtr);


uint8 broadcastMsgGetSenderID(BroadcastMessage* msgPtr);


uint8 broadcastMsgGetSenderIDNbr(BroadcastMessage* msgPtr, Nbr* nbrPtr);


uint8 broadcastMsgGetTimestampNbr(BroadcastMessage* msgPtr, Nbr* nbrPtr);


uint8 broadcastMsgGetTimestamp(BroadcastMessage* msgPtr);



void nbrListPrintHops(NbrList* nbrListPtr, BroadcastMessage* broadcastMessagePtr, char* name);


NbrList* nbrListGetParents(NbrList* nbrListParents, NbrList* nbrListIn, BroadcastMessage* msgPtr);


NbrList* nbrListGetSiblings(NbrList* nbrListSiblings, NbrList* nbrListIn, BroadcastMessage* msgPtr);


NbrList* nbrListGetChildren(NbrList* nbrListChildren, NbrList* nbrListIn, BroadcastMessage* msgPtr);


Nbr* nbrListFindSource(NbrList* nbrListPtr, BroadcastMessage* msgPtr);



//TODO: Not Connected ton anything
void nbrListPickParents(NbrList* ParentListOut1, NbrList* Parents, NbrList* Siblings,BroadcastMessage* msgPtr);


//TODO: implement or remove?
//void nbrListSortParents(nbrList* ParentListOut, nbrList* ParentListIn,BroadcastMessage* msgPtr);
//void nbrListPrint(NbrList* nbrListPtr, char* name);
//void nbrListPrintDebug(NbrList* nbrListPtr, char* name);

//void broadcastMsgSetHops(uint8 hops);
//uint8 broadcastMsgGetChildCountNbr(Nbr* nbrPtr);
//uint8 broadcastMsgGetParentIDNbr(Nbr* nbrPtr);
//void broadcastMsgSetStationary(uint8 stationary);
//void broadcastMsgSetChildCount(uint8 childrenCount);
//void broadcastMsgSetParentID(uint8 parentID);
//void broadcastMsgSetData(uint8 sourceID, uint8 hops, uint8 childrenCount, uint8 stationary, uint8 parentID);


#endif /* BROADCASTCOMMS_H_ */