Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ungive committed Aug 5, 2024
1 parent 124e108 commit 853a5ae
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions clients/cpp/include/loon/client.h
Original file line number Diff line number Diff line change
Expand Up @@ -399,13 +399,14 @@ struct ClientOptions
/**
* @brief Automatically disconnect after the given idle duration.
*
* Idling is defined as being connect without having content registered.
* If there is no registered content and no content is registered
* within the given duration, the client will disconnect from the server.
*
* Should content be registered while being disconnected,
* the client will reconnect to the server and then register the content,
* given that the client is in a started state of course.
* Idling is defined as being connected without having content registered
* or having entered idle state explicitly with the IClient::idle() method.
* If content is registered within the given duration,
* the client will disconnect from the server.
*
* Should content be registered while being disconnected due to idling,
* then the client will reconnect to and then register the content,
* if the client is in started state.
*/
std::optional<std::chrono::milliseconds> disconnect_after_idle{};

Expand Down

0 comments on commit 853a5ae

Please sign in to comment.