annotate LossyCom.c @ 1:826448e34e80

added data to message handler
author Merten Sach <msach@mailbox.tu-berlin.de>
date Thu, 08 Mar 2012 20:06:00 +0100
parents 29d8b41926f0
children b6dd31dbab8c
rev   line source
msach@0 1
msach@0 2 /*
msach@0 3 * For a detailed description see header file.
msach@0 4 */
msach@0 5
msach@0 6 #include "LossyCom.h"
msach@0 7
msach@0 8 #include "VMS_Implementations/VMS_impl/vmalloc.h"
msach@0 9
msach@0 10 /*
msach@0 11 * Initializes the central exchange structure.
msach@0 12 * Allocates memory to fit the number of endpoints.
msach@0 13 * Returns NULL if an error occurs.
msach@0 14 */
msach@0 15 lossyCom__exchange_t* lossyCom__initialize(uint16_t numEndpoints)
msach@0 16 {
msach@0 17 lossyCom__exchange_t* exchange;
msach@0 18
msach@0 19 exchange = VMS_WL__malloc(sizeof(lossyCom__exchange_t));
msach@0 20 if(exchange == NULL)
msach@0 21 return NULL;
msach@0 22
msach@0 23 exchange->triggerCounter = 0;
msach@0 24 exchange->numEndpoints = numEndpoints;
msach@0 25 exchange->outboxArray = VMS_WL__malloc(sizeof(lossyCom__msg_t)*numEndpoints);
msach@0 26 if(exchange->outboxArray == NULL){
msach@0 27 VMS_WL__free(exchange);
msach@0 28 return NULL;
msach@0 29 }
msach@0 30
msach@0 31 return exchange;
msach@0 32 }
msach@0 33
msach@1 34 /*
msach@1 35 * Connects the local endpoint to the central exchange structure.
msach@1 36 * This registers a message handler that handles all the incomming messages.
msach@1 37 * Also an endpointID is set this ID has to be between 0 and total number of
msach@1 38 * endpoints-1 and the number has to be unique.
msach@1 39 */
msach@0 40 void lossyCom__initialize_endpoint(lossyCom__endpoint_t* localEndpoint,
msach@0 41 lossyCom__exchange_t* centralExchange,
msach@0 42 lossyCom__endpointID_t endpointID,
msach@1 43 lossyCom__msgHandler msgHandler,
msach@1 44 void* msgHandlerData)
msach@0 45 {
msach@0 46 localEndpoint->localTriggerCopy = 0;
msach@0 47 localEndpoint->endpointID = endpointID;
msach@1 48 localEndpoint->centralExchange = centralExchange;
msach@1 49 localEndpoint->msgHandler = msgHandler;
msach@1 50 localEndpoint->msgHandlerData = msgHandlerData;
msach@0 51 }
msach@0 52
msach@1 53 /*
msach@1 54 * This broadcasts a message to all connected receivers
msach@1 55 */
msach@0 56 void inline lossyCom__broadcastMsg(lossyCom__endpoint_t* localEndpoint,
msach@0 57 lossyCom__msgBody_t msg)
msach@0 58 {
msach@0 59 lossyCom__sendMsg(localEndpoint,
msach@0 60 BROADCAST_ID,
msach@0 61 msg);
msach@0 62 }
msach@0 63
msach@1 64 /*
msach@1 65 * This sends a message another endpoint. Again it is not guaranteed that the
msach@1 66 * message is received. But in most cases it will.
msach@1 67 */
msach@0 68 void inline lossyCom__sendMsg(lossyCom__endpoint_t* localEndpoint,
msach@0 69 lossyCom__endpointID_t receiverEndpointID,
msach@0 70 lossyCom__msgBody_t msg)
msach@0 71 {
msach@0 72 lossyCom__msg_t msgDraft;
msach@0 73 uint16_t triggerCopy;
msach@0 74
msach@1 75 //build message
msach@0 76 msgDraft = (0 | msg);
msach@0 77 msgDraft |= ((lossyCom__msg_t)receiverEndpointID << ENDPOINT_ID_SHIFT);
msach@0 78
msach@1 79 triggerCopy = localEndpoint->centralExchange->triggerCounter +1;
msach@0 80 msgDraft |= ((lossyCom__msg_t)triggerCopy << TRIGGER_SHIFT);
msach@0 81
msach@0 82 //write msg to central exchange
msach@1 83 localEndpoint->centralExchange->outboxArray[localEndpoint->endpointID] =
msach@0 84 msgDraft;
msach@0 85
msach@1 86 localEndpoint->centralExchange->triggerCounter = triggerCopy;
msach@0 87 }
msach@0 88
msach@0 89 void inline lossyCom__receiveMsg(lossyCom__endpoint_t* localEndpoint)
msach@0 90 {
msach@1 91 uint16_t currentTriggerCopy;
msach@0 92 lossyCom__endpointID_t senderEndpointID;
msach@0 93 lossyCom__msg_t msgCopy;
msach@0 94 uint16_t msgTrigger;
msach@0 95 lossyCom__msgBody_t msgBody;
msach@0 96
msach@0 97 senderEndpointID = 0;
msach@1 98 currentTriggerCopy = localEndpoint->centralExchange->triggerCounter;
msach@1 99
msach@0 100 //new message arrived if trigger counter is higher than the last time read
msach@1 101 while(senderEndpointID < localEndpoint->centralExchange->numEndpoints)
msach@0 102 {
msach@0 103 if(senderEndpointID != localEndpoint->endpointID)
msach@0 104 {
msach@1 105 msgCopy = localEndpoint->centralExchange->outboxArray[senderEndpointID];
msach@0 106 msgTrigger = 0xFFFF & (msgCopy >> TRIGGER_SHIFT);
msach@1 107 // check if the message is new (msg trigger > archived trigger)
msach@1 108 // and already valid (msgTrigger <= currentTriggerCopy)
msach@0 109 if(msgTrigger > localEndpoint->localTriggerCopy &&
msach@1 110 msgTrigger <= currentTriggerCopy)
msach@0 111 {
msach@1 112 //let the message handler parse the message
msach@0 113 msgBody = 0xFFFFFFFF & msgCopy;
msach@1 114 (*(localEndpoint->msgHandler))(senderEndpointID,
msach@1 115 msgBody,
msach@1 116 localEndpoint->msgHandlerData);
msach@0 117 }
msach@0 118 }
msach@0 119 senderEndpointID++;
msach@0 120 }
msach@0 121 //save last parsed msg
msach@1 122 localEndpoint->localTriggerCopy = currentTriggerCopy;
msach@0 123 }