The call restrictions of ten_env APIs need to be clarified

[sunxilin]

The ten_env APIs are not safe to be called in any context or in any thread, so we need to clarify these call restrictions and the exceptions or error messages under incorrect calls.

[halajohn]

Some APIs in ten_env already include checks for verifying the correct timing of their invocation. For example, when calling on_configure_done, the TEN runtime ensures that the extension is in the proper state. Using a similar mechanism, we could implement timing checks for all other ten_env APIs.

bool ten_extension_on_configure_done(ten_env_t *self) {
  TEN_ASSERT(self, "Invalid argument.");
  TEN_ASSERT(ten_env_check_integrity(self, true), "Invalid use of ten_env %p.",
             self);

  ten_extension_t *extension = ten_env_get_attached_extension(self);
  TEN_ASSERT(extension, "Invalid argument.");
  TEN_ASSERT(ten_extension_check_integrity(extension, true),
             "Invalid use of extension %p.", extension);

  TEN_LOGD("[%s] on_configure() done.",
           ten_extension_get_name(extension, true));

  if (extension->state != TEN_EXTENSION_STATE_INIT) {    // <== timing check
    TEN_LOGI("[%s] Failed to on_configure_done() because of incorrect timing.",
             ten_extension_get_name(extension, true));
    return false;
  }
}

By leveraging this approach, it is possible to extend similar checks to other APIs in ten_env. This would help enforce proper timing across all API calls, enhancing the robustness of the framework.

[halajohn]

Some APIs in ten_env already include checks for verifying the correct timing of their invocation. For example, when calling on_configure_done, the TEN runtime ensures that the extension is in the proper state. Using a similar mechanism, we could implement timing checks for all other ten_env APIs.

bool ten_extension_on_configure_done(ten_env_t *self) {
  TEN_ASSERT(self, "Invalid argument.");
  TEN_ASSERT(ten_env_check_integrity(self, true), "Invalid use of ten_env %p.",
             self);

  ten_extension_t *extension = ten_env_get_attached_extension(self);
  TEN_ASSERT(extension, "Invalid argument.");
  TEN_ASSERT(ten_extension_check_integrity(extension, true),
             "Invalid use of extension %p.", extension);

  TEN_LOGD("[%s] on_configure() done.",
           ten_extension_get_name(extension, true));

  if (extension->state != TEN_EXTENSION_STATE_INIT) {    // <== timing check
    TEN_LOGI("[%s] Failed to on_configure_done() because of incorrect timing.",
             ten_extension_get_name(extension, true));
    return false;
  }
}

By leveraging this approach, it is possible to extend similar checks to other APIs in ten_env. This would help enforce proper timing across all API calls, enhancing the robustness of the framework.