Commit 789e82d2 authored by Scott Vokes's avatar Scott Vokes
Browse files

Rename operation callback to opCallback to make distinct from closure callback. 

(Don't change closure callback because it's part of the public API.)
parent 15bbd030

src/lib/kinetic_builder.c

+14 −14
Original line number Diff line number Diff line
@@ -47,7 +47,7 @@ KineticStatus KineticBuilder_BuildNoop(KineticOperation* const op) 
    KineticOperation_ValidateOperation(op);

    op->request->message.command.header->messageType = KINETIC_PROTO_COMMAND_MESSAGE_TYPE_NOOP;

    op->request->message.command.header->has_messageType = true;

    op->callback = &KineticCallbacks_Basic;

    op->opCallback = &KineticCallbacks_Basic;

    return KINETIC_STATUS_SUCCESS;

}
@@ -69,7 +69,7 @@ KineticStatus KineticBuilder_BuildPut(KineticOperation* const op, 


    op->value.data = op->entry->value.array.data;

    op->value.len = op->entry->value.bytesUsed;

    op->callback = &KineticCallbacks_Put;

    op->opCallback = &KineticCallbacks_Put;



    return KINETIC_STATUS_SUCCESS;

}
@@ -93,7 +93,7 @@ static void build_get_command(KineticOperation* const op, 
        op->value.len = op->entry->value.bytesUsed;

    }



    op->callback = cb;

    op->opCallback = cb;

}



KineticStatus KineticBuilder_BuildGet(KineticOperation* const op,
@@ -130,7 +130,7 @@ KineticStatus KineticBuilder_BuildFlush(KineticOperation* const op) 
    op->request->message.command.header->messageType =

        KINETIC_PROTO_COMMAND_MESSAGE_TYPE_FLUSHALLDATA;

    op->request->message.command.header->has_messageType = true;

    op->callback = &KineticCallbacks_Basic;

    op->opCallback = &KineticCallbacks_Basic;



    return KINETIC_STATUS_SUCCESS;

}
@@ -152,7 +152,7 @@ KineticStatus KineticBuilder_BuildDelete(KineticOperation* const op, 
        op->value.len = op->entry->value.bytesUsed;

    }



    op->callback = &KineticCallbacks_Delete;

    op->opCallback = &KineticCallbacks_Delete;



    return KINETIC_STATUS_SUCCESS;

}
@@ -170,7 +170,7 @@ KineticStatus KineticBuilder_BuildGetKeyRange(KineticOperation* const op, 
    KineticMessage_ConfigureKeyRange(&op->request->message, range);



    op->buffers = buffers;

    op->callback = &KineticCallbacks_GetKeyRange;

    op->opCallback = &KineticCallbacks_GetKeyRange;



    return KINETIC_STATUS_SUCCESS;

}
@@ -254,7 +254,7 @@ KineticStatus KineticBuilder_BuildP2POperation(KineticOperation* const op, 
    op->request->command->header->has_messageType = true;

    op->request->command->body = &op->request->message.body;

    op->p2pOp = p2pOp;

    op->callback = &KineticCallbacks_P2POperation;

    op->opCallback = &KineticCallbacks_P2POperation;



    op->request->command->body->p2pOperation = build_p2pOp(0, p2pOp);
@@ -299,7 +299,7 @@ KineticStatus KineticBuilder_BuildGetLog(KineticOperation* const op, 
    }



    op->deviceInfo = info;

    op->callback = &KineticCallbacks_GetLog;

    op->opCallback = &KineticCallbacks_GetLog;



    return KINETIC_STATUS_SUCCESS;

}
@@ -330,7 +330,7 @@ KineticStatus KineticBuilder_BuildSetPin(KineticOperation* const op, ByteArray o 
        op->request->message.security.has_newErasePIN = true;

    }

    

    op->callback = &KineticCallbacks_Basic;

    op->opCallback = &KineticCallbacks_Basic;

    op->request->pinAuth = false;

    op->timeoutSeconds = KineticOperation_TimeoutSetPin;
@@ -351,7 +351,7 @@ KineticStatus KineticBuilder_BuildErase(KineticOperation* const op, bool secure_ 
        KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_ERASE_PINOP;

    op->request->command->body->pinOp->has_pinOpType = true;

    

    op->callback = &KineticCallbacks_Basic;

    op->opCallback = &KineticCallbacks_Basic;

    op->request->pinAuth = true;

    op->timeoutSeconds = KineticOperation_TimeoutErase;
@@ -373,7 +373,7 @@ KineticStatus KineticBuilder_BuildLockUnlock(KineticOperation* const op, bool lo 
        KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_UNLOCK_PINOP;

    op->request->command->body->pinOp->has_pinOpType = true;

    

    op->callback = &KineticCallbacks_Basic;

    op->opCallback = &KineticCallbacks_Basic;

    op->request->pinAuth = true;

    op->timeoutSeconds = KineticOperation_TimeoutLockUnlock;
@@ -392,7 +392,7 @@ KineticStatus KineticBuilder_BuildSetClusterVersion(KineticOperation* op, int64_ 
    op->request->command->body->setup->newClusterVersion = new_cluster_version;

    op->request->command->body->setup->has_newClusterVersion = true;



    op->callback = &KineticCallbacks_SetClusterVersion;

    op->opCallback = &KineticCallbacks_SetClusterVersion;

    op->pendingClusterVersion = new_cluster_version;



    return KINETIC_STATUS_SUCCESS;
@@ -411,7 +411,7 @@ KineticStatus KineticBuilder_BuildSetACL(KineticOperation* const op, 
    op->request->command->body->security->n_acl = ACLs->ACL_count;

    op->request->command->body->security->acl = ACLs->ACLs;



    op->callback = &KineticCallbacks_SetACL;

    op->opCallback = &KineticCallbacks_SetACL;

    op->timeoutSeconds = KineticOperation_TimeoutSetACL;



    return KINETIC_STATUS_SUCCESS;
@@ -480,7 +480,7 @@ KineticStatus KineticBuilder_BuildUpdateFirmware(KineticOperation* const op, con 
    op->request->command->body->setup->firmwareDownload = true;

    op->request->command->body->setup->has_firmwareDownload = true;



    op->callback = &KineticCallbacks_UpdateFirmware;

    op->opCallback = &KineticCallbacks_UpdateFirmware;



    return KINETIC_STATUS_SUCCESS;

src/lib/kinetic_controller.c

+2 −2
Original line number Diff line number Diff line
@@ -255,8 +255,8 @@ void KineticController_HandleResult(bus_msg_result_t *res, void *udata) 
    }



    // Call operation-specific callback, if configured

    if (op->callback != NULL) {

        status = op->callback(op, status);

    if (op->opCallback != NULL) {

        status = op->opCallback(op, status);

    }



    KineticOperation_Complete(op, status);

src/lib/kinetic_types_internal.h

+1 −1
Original line number Diff line number Diff line
@@ -186,7 +186,7 @@ struct _KineticOperation { 
    ByteBufferArray* buffers;

    KineticLogInfo** deviceInfo;

    KineticP2P_Operation* p2pOp;

    KineticOperationCallback callback;

    KineticOperationCallback opCallback;

    KineticCompletionClosure closure;

    ByteArray value;

};

test/unit/test_kinetic_builder.c

+18 −18
Original line number Diff line number Diff line
@@ -178,7 +178,7 @@ void test_KineticBuilder_BuildGet_should_build_a_GET_operation(void) 


    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GET, Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -206,7 +206,7 @@ void test_KineticBuilder_BuildGet_should_build_a_GET_operation_requesting_metada 


    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GET, Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL_PTR(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -234,7 +234,7 @@ void test_KineticBuilder_BuildGetNext_should_build_a_GETNEXT_operation(void) 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GETNEXT,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -263,7 +263,7 @@ void test_KineticBuilder_BuildGetNext_should_build_a_GETNEXT_operation_with_meta 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GETNEXT,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL_PTR(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -291,7 +291,7 @@ void test_KineticBuilder_BuildGetPrevious_should_build_a_GETPREVIOUS_operation(v 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GETPREVIOUS,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -320,7 +320,7 @@ void test_KineticBuilder_BuildGetPrevious_should_build_a_GETPREVIOUS_operation_w 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GETPREVIOUS,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Get, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL_PTR(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -341,7 +341,7 @@ void test_KineticBuilder_BuildFlush_should_build_a_FLUSHALLDATA_operation(void) 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_FLUSHALLDATA,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_FALSE(Request.pinAuth);

    TEST_ASSERT_EQUAL(0, Operation.timeoutSeconds);
@@ -364,7 +364,7 @@ void test_KineticBuilder_BuildDelete_should_build_a_DELETE_operation(void) 
    TEST_ASSERT_TRUE(Request.message.command.header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_DELETE,

        Request.message.command.header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Delete, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_Delete, Operation.opCallback);

    TEST_ASSERT_EQUAL_PTR(value.data, Operation.entry->value.array.data);

    TEST_ASSERT_EQUAL_PTR(value.len, Operation.entry->value.array.len);

    TEST_ASSERT_EQUAL(0, Operation.entry->value.bytesUsed);
@@ -409,7 +409,7 @@ void test_KineticBuilder_BuildGetKeyRange_should_build_a_GetKeyRange_request(voi 
    TEST_ASSERT_TRUE(Request.command->header->has_messageType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_MESSAGE_TYPE_GETKEYRANGE,

        Request.command->header->messageType);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_GetKeyRange, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(KineticCallbacks_GetKeyRange, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.entry);

    TEST_ASSERT_EQUAL_PTR(&Request, Operation.request);

    TEST_ASSERT_FALSE(Request.pinAuth);
@@ -678,7 +678,7 @@ void test_KineticBuilder_BuildSetPin_should_build_a_SECURITY_operation_to_set_ne 
    TEST_ASSERT_EQUAL_PTR(newPinData, Request.command->body->security->newLockPIN.data);

    TEST_ASSERT_EQUAL(newPin.len, Request.command->body->security->newLockPIN.len);

    TEST_ASSERT_NULL(Request.command->body->pinOp);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

}
@@ -707,7 +707,7 @@ void test_KineticBuilder_BuildSetPin_should_build_a_SECURITY_operation_to_set_ne 
    TEST_ASSERT_EQUAL_PTR(newPinData, Request.command->body->security->newErasePIN.data);

    TEST_ASSERT_EQUAL(newPin.len, Request.command->body->security->newErasePIN.len);

    TEST_ASSERT_NULL(Request.command->body->pinOp);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

}
@@ -732,7 +732,7 @@ void test_KineticBuilder_BuildErase_should_build_a_SECURE_ERASE_operation_with_P 
    TEST_ASSERT_TRUE(&Request.message.pinOp.has_pinOpType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_SECURE_ERASE_PINOP,

        Request.command->body->pinOp->pinOpType);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

    TEST_ASSERT_EQUAL(180, Operation.timeoutSeconds);

}
@@ -757,7 +757,7 @@ void test_KineticBuilder_BuildErase_should_build_an_INSTANT_ERASE_operation_with 
    TEST_ASSERT_TRUE(&Request.message.pinOp.has_pinOpType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_ERASE_PINOP,

        Request.command->body->pinOp->pinOpType);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

    TEST_ASSERT_EQUAL(KineticOperation_TimeoutErase, Operation.timeoutSeconds);

}
@@ -782,7 +782,7 @@ void test_KineticBuilder_BuildLockUnlock_should_build_a_LOCK_operation_with_PIN_ 
    TEST_ASSERT_TRUE(&Request.message.pinOp.has_pinOpType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_LOCK_PINOP,

        Request.command->body->pinOp->pinOpType);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

    TEST_ASSERT_EQUAL(KineticOperation_TimeoutLockUnlock, Operation.timeoutSeconds);

}
@@ -807,7 +807,7 @@ void test_KineticBuilder_BuildLockUnlock_should_build_an_UNLOCK_operation_with_P 
    TEST_ASSERT_TRUE(&Request.message.pinOp.has_pinOpType);

    TEST_ASSERT_EQUAL(KINETIC_PROTO_COMMAND_PIN_OPERATION_PIN_OP_TYPE_UNLOCK_PINOP,

        Request.command->body->pinOp->pinOpType);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_Basic, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

    TEST_ASSERT_EQUAL(KineticOperation_TimeoutLockUnlock, Operation.timeoutSeconds);

}
@@ -831,7 +831,7 @@ void test_KineticBuilder_BuildSetClusterVersion_should_build_a_SET_CLUSTER_VERSI 
    TEST_ASSERT_EQUAL_INT64(1776, Operation.pendingClusterVersion);

    TEST_ASSERT_TRUE(Request.message.setup.has_newClusterVersion);

    TEST_ASSERT_FALSE(Request.message.setup.has_firmwareDownload);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_SetClusterVersion, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_SetClusterVersion, Operation.opCallback);

}



void test_KineticBuilder_BuildSetACL_should_build_a_SECURITY_operation(void)
@@ -858,7 +858,7 @@ void test_KineticBuilder_BuildSetACL_should_build_a_SECURITY_operation(void) 


    TEST_ASSERT_EQUAL_PTR(Request.command->body->security->acl, ACLs.ACLs);



    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_SetACL, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_SetACL, Operation.opCallback);

    TEST_ASSERT_NULL(Operation.response);

    TEST_ASSERT_EQUAL(KineticOperation_TimeoutSetACL, Operation.timeoutSeconds);

}
@@ -888,7 +888,7 @@ void test_KineticBuilder_BuildUpdateFirmware_should_build_a_FIRMWARE_DOWNLOAD_op 
    TEST_ASSERT_EQUAL_PTR(&Request.message.setup, Request.command->body->setup);

    TEST_ASSERT_TRUE(Request.message.setup.firmwareDownload);

    TEST_ASSERT_TRUE(Request.message.setup.has_firmwareDownload);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_UpdateFirmware, Operation.callback);

    TEST_ASSERT_EQUAL_PTR(&KineticCallbacks_UpdateFirmware, Operation.opCallback);



    TEST_ASSERT_NOT_NULL(Operation.value.data);

    TEST_ASSERT_EQUAL(fwLen, Operation.value.len);