Skip to content

Commit 6306a69

Browse files
committed
document SR_ERR_DISCONNECT error
1 parent 05bb4ae commit 6306a69

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

inc/sysrepo.h

+5
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,11 @@ typedef enum sr_datastore_e {
368368
/**
369369
* @brief Connects to the sysrepo datastore (Sysrepo Engine).
370370
*
371+
* @note If the client library loses connection to the Sysrepo Engine during
372+
* the lifetime of the application, all Sysrepo API calls will start returning
373+
* ::SR_ERR_DISCONNECT error. In this case, the application is supposed to reconnect
374+
* with another ::sr_connect call and restart all lost sessions.
375+
*
371376
* @param[in] app_name Name of the application connecting to the datastore
372377
* (can be a static string). Used only for accounting purposes.
373378
* @param[in] opts Options overriding default connection handling by this call.

0 commit comments

Comments
 (0)