Sending NONCE and TTL in the payload for active presence:

Patch set #1:
1) The payload is formatted as NONCE#:TTL#
2) NONCE is a 32bit unisgned random int.
3) The client app is not called when there is not change in NONCE, OC_STACK_PRESENCE_NO_UPDATE was deleted
4) Code organization in occoap.c
5) Rebased on master

Change-Id: I2c4f8c4b30c3d692a38b3286001d55f3387f5a73

diff --git a/csdk/occoap/src/occoap.c b/csdk/occoap/src/occoap.c
index 33a8219..9e952b7 100644 (file)
--- a/csdk/occoap/src/occoap.c
+++ b/csdk/occoap/src/occoap.c
@@ -266,8 +266,12 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
     uint16_t remotePortNu;
     unsigned char fullUri[MAX_URI_LENGTH] = { 0 };
     unsigned char rcvdUri[MAX_URI_LENGTH] = { 0 };
+    uint8_t isObserveNotification = 0;
     #ifdef WITH_PRESENCE
-    uint8_t isPresenceUpdate = 0;
+    uint8_t isPresenceNotification = 0;
+    uint32_t lowerBound;
+    uint32_t higherBound;
+    char * tok = NULL;
     #endif
 
     VERIFY_NON_NULL(ctx);
@@ -285,16 +289,30 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
         maxAge = *((uint32_t *) rcvMaxAgeOption);
     }
 
+    OC_LOG_V(DEBUG, TAG, "The sequenceNumber/NONCE of this response %u", sequenceNumber);
+    OC_LOG_V(DEBUG, TAG, "The maxAge/TTL of this response %u", maxAge);
+    OC_LOG_V(DEBUG, TAG, "The response received is %s", bufRes);
+
+    if(sequenceNumber != 0)
+    {
+        isObserveNotification = 1;
+        OC_LOG(INFO, TAG, PCF("Received an observe notification"));
+    }
+
     #ifdef WITH_PRESENCE
     if(!strcmp((char *)rcvdUri, (char *)OC_PRESENCE_URI)){
-        isPresenceUpdate = 1;
+        isPresenceNotification = 1;
+        OC_LOG(INFO, TAG, PCF("Received a presence notification"));
+        tok = strtok((char *)bufRes, ":");
+        sequenceNumber = (uint32_t )atoi(tok);
+        OC_LOG_V(DEBUG, TAG, "The received NONCE is %u", sequenceNumber);
+        tok = strtok(NULL, ":");
+        maxAge = (uint32_t )atoi(tok);
+        OC_LOG_V(DEBUG, TAG, "The received TTL is %u", maxAge);
+        bufRes[strlen((char *)bufRes)] = ':';
     }
     #endif
 
-    OC_LOG_V(DEBUG, TAG, "The sequence number of this response %d", sequenceNumber);
-    OC_LOG_V(DEBUG, TAG, "The max age of this response %d", maxAge);
-    OC_LOG_V(DEBUG, TAG, "The response received is %s", bufRes);
-
     // fill OCCoAPToken structure
     result = RetrieveOCCoAPToken(recvPdu, &rcvdToken);
     VERIFY_SUCCESS(result, OC_STACK_OK);
@@ -326,67 +344,37 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
 
     if(cbNode)
     {
-        // following if statement is handling responses of
-        // observation/presence notifications
-        #ifdef WITH_PRESENCE
-        if((clientResponse->sequenceNumber != 0 || isPresenceUpdate) &&
-                (cbNode->method == OC_REST_OBSERVE ||
-                        cbNode->method == OC_REST_OBSERVE_ALL ||
-                        cbNode->method == OC_REST_PRESENCE))
-        #else
-        if((clientResponse->sequenceNumber != 0) &&
-                (cbNode->method == OC_REST_OBSERVE ||
-                        cbNode->method == OC_REST_OBSERVE_ALL))
-        #endif
+        if(isObserveNotification)
         {
-            OC_LOG(INFO, TAG, PCF("Received an observe/presence notification"));
-            // we should not ACK when it is presence notification
-            // since presence notification is snet with muticast
-            #ifdef WITH_PRESENCE
-            if(recvPdu->hdr->type == COAP_MESSAGE_CON &&
-                    !isPresenceUpdate && cbNode->method != OC_REST_PRESENCE)
-            #else
+            OC_LOG(INFO, TAG, PCF("Received an observe notification"));
             if(recvPdu->hdr->type == COAP_MESSAGE_CON)
-            #endif
-                {
+            {
                 sendPdu = GenerateCoAPPdu(COAP_MESSAGE_ACK, 0,
                         recvPdu->hdr->id, NULL, NULL, NULL);
                 VERIFY_NON_NULL(sendPdu);
                 result = SendCoAPPdu(gCoAPCtx, (coap_address_t*) &rcvdResponse->remote,
                         sendPdu, 0);
             }
-            // we only process newer sequence numbers for OC_REST_OBSERVE and OC_REST_PRESENCE
-            #ifdef WITH_PRESENCE
-            if((cbNode->method == OC_REST_OBSERVE &&
-                    clientResponse->sequenceNumber <= cbNode->sequenceNumber) ||
-                    (cbNode->method == OC_REST_PRESENCE &&
-                            clientResponse->sequenceNumber < cbNode->sequenceNumber))
-            #else
             if(cbNode->method == OC_REST_OBSERVE &&
                     clientResponse->sequenceNumber <= cbNode->sequenceNumber)
-            #endif
             {
                 OC_LOG_V(DEBUG, TAG, "Observe notification came out of order. \
                         Ignoring Incoming:%d  Against Current:%d.",
                         clientResponse->sequenceNumber, cbNode->sequenceNumber);
                 goto exit;
             }
-            // in the case the presence update has the same sequence number
-            // as previous ones, we signal it as OC_STACK_PRESENCE_NO_UPDATE
-            // no change happend on server's resources
-            #ifdef WITH_PRESENCE
-            if(isPresenceUpdate && cbNode->sequenceNumber == clientResponse->sequenceNumber)
-            {
-                response->clientResponse->result = OC_STACK_PRESENCE_NO_UPDATE;
-            }
-            #endif
-            // update the monitored sequence number.
             if(clientResponse->sequenceNumber > cbNode->sequenceNumber){
                 cbNode->sequenceNumber = clientResponse->sequenceNumber;
             }
+        }
+        else
+        {
             #ifdef WITH_PRESENCE
-            if(isPresenceUpdate && cbNode->method == OC_REST_PRESENCE){
-                if(!cbNode->presence){
+            if(isPresenceNotification)
+            {
+                OC_LOG(INFO, TAG, PCF("Received a presence notification"));
+                if(!cbNode->presence)
+                {
                     cbNode->presence = (OCPresence *) OCMalloc(sizeof(OCPresence));
                     VERIFY_NON_NULL(cbNode->presence);
                     cbNode->presence->timeOut = NULL;
@@ -397,13 +385,15 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
                         goto exit;
                     }
                 }
-                cbNode->presence->TTL = maxAge;
-                uint32_t lowerBound;
-                uint32_t higherBound;
-                if(maxAge)
+                if(maxAge == 0)
                 {
-                    uint32_t now = GetTime(0);
-                    OC_LOG_V(DEBUG, TAG, "----------------current ticks  %d", now);
+                    OC_LOG(INFO, TAG, "===============Stopping presence");
+                    response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
+                }
+                else
+                {
+                    OC_LOG_V(INFO, TAG, "===============Update presence TTL, now time is %d", GetTime(0));
+                    cbNode->presence->TTL = maxAge;
                     for(int index = 0; index < PresenceTimeOutSize; index++)
                     {
                         lowerBound = GetTime(((float)(PresenceTimeOut[index])
@@ -417,22 +407,20 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
                     }
                     cbNode->presence->TTLlevel = 0;
                     OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
-                }
-                else
-                {
-                    OC_LOG(INFO, TAG, "===============Stopping presence");
-                    response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
+                    if(cbNode->sequenceNumber == clientResponse->sequenceNumber)
+                    {
+                        OC_LOG(INFO, TAG, "===============No presence change");
+                        goto exit;
+                    }
+                    OC_LOG(INFO, TAG, "===============Presence changed, calling up the stack");
+                    cbNode->sequenceNumber = clientResponse->sequenceNumber;;
                 }
             }
             #endif
         }
         HandleStackResponses(response);
     }
-    #ifdef WITH_PRESENCE
-    else if(!cbNode && clientResponse->sequenceNumber != 0 && !isPresenceUpdate)
-    #else
-    else if(!cbNode && clientResponse->sequenceNumber != 0)
-    #endif
+    else if(!cbNode && isObserveNotification)
     {
         OC_LOG(INFO, TAG, PCF("Received an observe notification, but I do not have callback \
                  ------------ sending RESET"));
@@ -443,7 +431,7 @@ static void HandleCoAPResponses(struct coap_context_t *ctx,
         VERIFY_SUCCESS(result, OC_STACK_OK);
     }
     #ifdef WITH_PRESENCE
-    else if(!cbNode && clientResponse->sequenceNumber != 0 && isPresenceUpdate)
+    else if(!cbNode && isPresenceNotification)
     {
         OC_LOG(INFO, TAG, PCF("Received a presence notification, but I do not have callback \
                          ------------ ignoring"));
@@ -651,8 +639,20 @@ OCStackResult OCSendCoAPNotification (unsigned char * uri, OCDevAddr *dstAddr, O
         coapMsgType = COAP_MESSAGE_CON;
     }
 
-    result = FormOptionList(&optList, &mediaType, &maxAge, 4, (uint8_t *)(&seqNum),
-            NULL, strlen((char *)uri), uri, 0, NULL);
+    #ifdef WITH_PRESENCE
+    if(!strcmp((const char *)uri, OC_PRESENCE_URI))
+    {
+        result = FormOptionList(&optList, &mediaType, NULL, 0, NULL,
+                NULL, strlen((char *)uri), uri, 0, NULL);
+    }
+    else
+    {
+    #endif
+        result = FormOptionList(&optList, &mediaType, &maxAge, 4,
+                (uint8_t *)(&seqNum), NULL, strlen((char *)uri), uri, 0, NULL);
+    #ifdef WITH_PRESENCE
+    }
+    #endif
     VERIFY_SUCCESS(result, OC_STACK_OK);
 
     sendPdu = GenerateCoAPPdu(

diff --git a/csdk/stack/include/ocstack.h b/csdk/stack/include/ocstack.h
index 5570d95..9b544b5 100644 (file)
--- a/csdk/stack/include/ocstack.h
+++ b/csdk/stack/include/ocstack.h
@@ -128,7 +128,6 @@ typedef enum {
     OC_STACK_OBSERVER_NOT_ADDED,
     OC_STACK_OBSERVER_NOT_REMOVED,
     #ifdef WITH_PRESENCE
-    OC_STACK_PRESENCE_NO_UPDATE,
     OC_STACK_PRESENCE_STOPPED,
     OC_STACK_PRESENCE_DO_NOT_HANDLE,
     #endif

diff --git a/csdk/stack/samples/linux/SimpleClientServer/common.cpp b/csdk/stack/samples/linux/SimpleClientServer/common.cpp
index 8c96d6e..69207a6 100644 (file)
--- a/csdk/stack/samples/linux/SimpleClientServer/common.cpp
+++ b/csdk/stack/samples/linux/SimpleClientServer/common.cpp
@@ -55,8 +55,6 @@ const char *getResult(OCStackResult result) {
     case OC_STACK_NO_OBSERVERS:
         return "OC_STACK_NO_OBSERVERS";
     #ifdef WITH_PRESENCE
-    case OC_STACK_PRESENCE_NO_UPDATE:
-        return "OC_STACK_PRESENCE_NO_UPDATE";
     case OC_STACK_PRESENCE_DO_NOT_HANDLE:
         return "OC_STACK_PRESENCE_DO_NOT_HANDLE";
     case OC_STACK_PRESENCE_STOPPED:

diff --git a/csdk/stack/src/ocobserve.c b/csdk/stack/src/ocobserve.c
index e4495e3..5acb553 100644 (file)
--- a/csdk/stack/src/ocobserve.c
+++ b/csdk/stack/src/ocobserve.c
@@ -203,6 +203,9 @@ OCStackResult SendObserverNotification (OCMethod method, OCResource *resPtr, uin
             {
                 //we know it is the default entity handler
                 OC_LOG(DEBUG, TAG, "This notification is for Presence");
+                // we create the payload here
+                sprintf((char *)bufRes, "%u:%u", resPtr->sequenceNum, maxAge);
+                jsonPayload = bufRes;
                 ehRet = OC_EH_OK;
             }
             #endif

diff --git a/csdk/stack/src/ocstack.c b/csdk/stack/src/ocstack.c
index 8bdca7d..b9e28eb 100644 (file)
--- a/csdk/stack/src/ocstack.c
+++ b/csdk/stack/src/ocstack.c
@@ -726,7 +726,7 @@ OCStackResult OCCreateResource(OCResourceHandle *handle,
     result = OC_STACK_OK;
 
     #ifdef WITH_PRESENCE
-    incrementSequenceNumber((OCResource *)presenceResource.handle);
+    ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
     OCNotifyObservers(presenceResource.handle);
     #endif
 exit:
@@ -1392,6 +1392,8 @@ OCStackResult initResources() {
     result = OCChangeResourceProperty(
             &(((OCResource *) presenceResource.handle)->resourceProperties),
             OC_ACTIVE, 0);
+    //initialize the sequence number as a random 32-bit integer
+    ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
     #endif
     return result;
 }

diff --git a/examples/presenceclient.cpp b/examples/presenceclient.cpp
index d9a6a04..eefdb39 100644 (file)
--- a/examples/presenceclient.cpp
+++ b/examples/presenceclient.cpp
@@ -42,9 +42,6 @@ void presenceHandler(OCStackResult result, const int& nonce)
         case OC_STACK_OK:
             std::cout << "Nonce# " << nonce << std::endl;
             break;
-        case OC_STACK_PRESENCE_NO_UPDATE:
-            std::cout << "No presence update\n";
-            break;
         case OC_STACK_PRESENCE_STOPPED:
             std::cout << "Presence Stopped\n";
             break;