X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fuser-guide.rst;fp=docs%2Fuser-guide.rst;h=6024f9320b1da5797c593356b2b14b8a9fdf6cb3;hb=d565df6613d97c08664a00f3fbc7cb5fdcf233f6;hp=9b5d6a8a69a28a4e786e80e5dfa8d397579b9594;hpb=faf9fc79e58fa4ace9b0ef317b741afb2c1a8abe;p=ric-plt%2Fsdl.git diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 9b5d6a8..6024f93 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -498,6 +498,11 @@ Using SDL APIs operations. See waitReadyAsync() function `doxygen documentation <#doxygen-generated-sdl-api-documentation>`_ for corresponding asynchronous API for details. +* Use waitReady() function before doing first operation via synchronous + APIs to ensure that SDL and backend data storage are ready to handle + operations. See waitReady() function + `doxygen documentation <#doxygen-generated-sdl-api-documentation>`_ + for corresponding synchronous API for details. * Avoid using heavy search functions (for example: *AsyncStorage::findKeys()*). Rather define your keys so that you know which keys should be read.