Azure / azure-ulib-c

THIS REPO IS CURRENTLY IN PREVIEW. THE APIs ARE NOT FINAL AND ARE SUBJECT TO CHANGE WITHOUT NOTICE. Azure utility library used in embedded and constrained devices.
MIT License
14 stars 6 forks source link

Change IPC to use full name for interface. #73

Closed mamokarz closed 3 years ago

mamokarz commented 3 years ago
/** The `\0` terminated `az_span` with the capability name. */

Remove #Resolved


Refers to: inc/az_ulib_descriptor_api.h:45 in 0edc5ee. [](commit_id = 0edc5eec906c52559bd99c82ac16bceea536d10e, deletion_comment = False)

smcd253 commented 3 years ago
  • This API initialize the IPC. It shall be called only once, at the beginning of the code

nit: intializes


In reply to: 876715760


In reply to: 876715760

smcd253 commented 3 years ago
  • initialization process is completely done.

nit: "This API is not thread safe. The other IPC APIs shall only ve called after the initialization process is complete." #Pending


In reply to: 876718007


In reply to: 876718007


In reply to: 876718007


In reply to: 876718007


In reply to: 876718007

smcd253 commented 3 years ago
  • this init.

nit: "This API is not thread safe. No other IPC API may be called during the execution of this init."


In reply to: 876719970


In reply to: 876719970


In reply to: 876719970


Refers to: inc/az_ulib_ipc_api.h:86 in e295408. [](commit_id = e2954085c4fbf3c52cacb9453d8761839168dd03, deletion_comment = False)

smcd253 commented 3 years ago
  • @retval #AZ_OK If the IPC initialize with success.

nit: initializes


In reply to: 876720311


In reply to: 876720311


In reply to: 876720311


Refers to: inc/az_ulib_ipc_api.h:89 in e295408. [](commit_id = e2954085c4fbf3c52cacb9453d8761839168dd03, deletion_comment = False)

smcd253 commented 3 years ago
  • this deinit, and no other IPC API shall be running during the execution of this API.

nit: "This API is not thread safe. No other IPC API may be called during the execution of this deinit and no other IPC API shall be running during the execution of this API."


In reply to: 876724579


In reply to: 876724579


Refers to: inc/az_ulib_ipc_api.h:107 in e295408. [](commit_id = e2954085c4fbf3c52cacb9453d8761839168dd03, deletion_comment = False)

smcd253 commented 3 years ago
  • success.

nit: "... up to the point the interface is successfully unpublished."


In reply to: 876738303


In reply to: 876738303


In reply to: 876738303


Refers to: inc/az_ulib_ipc_api.h:155 in e295408. [](commit_id = e2954085c4fbf3c52cacb9453d8761839168dd03, deletion_comment = False)

mamokarz commented 3 years ago
  • this init.

This is actually duplicated. I'll remove it.


In reply to: 876719970


Refers to: inc/az_ulib_ipc_api.h:86 in e295408. [](commit_id = e2954085c4fbf3c52cacb9453d8761839168dd03, deletion_comment = False)

smcd253 commented 3 years ago

in.max_sum = 10000;

should have commented this in the original PR. Is this a hard limit for ipc?


In reply to: 877226924


In reply to: 877226924


Refers to: tests/tests_e2e/az_ulib_ipc_e2e/az_ulib_ipc_e2e.c:150 in 2e4b0b4. [](commit_id = 2e4b0b498dcf236d1516a735b16f3a14c2733b87, deletion_comment = False)

mamokarz commented 3 years ago

in.max_sum = 10000;

No, this is a randon number for an e2e test.


In reply to: 877226924


Refers to: tests/tests_e2e/az_ulib_ipc_e2e/az_ulib_ipc_e2e.c:150 in 2e4b0b4. [](commit_id = 2e4b0b498dcf236d1516a735b16f3a14c2733b87, deletion_comment = False)