From 2a56f602db30606017619b00db0e75f41b0bce35 Mon Sep 17 00:00:00 2001 From: Carsten Otto Date: Sun, 16 Oct 2022 11:18:30 +0200 Subject: [PATCH] wtclient: fix documentation [skip ci] the implementation also returns exhausted sessions --- watchtower/wtclient/interface.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/watchtower/wtclient/interface.go b/watchtower/wtclient/interface.go index c67d7eac3..5f2357950 100644 --- a/watchtower/wtclient/interface.go +++ b/watchtower/wtclient/interface.go @@ -57,11 +57,9 @@ type DB interface { // restarts. CreateClientSession(*wtdb.ClientSession) error - // ListClientSessions returns all sessions that have not yet been - // exhausted. This is used on startup to find any sessions which may - // still be able to accept state updates. An optional tower ID can be - // used to filter out any client sessions in the response that do not - // correspond to this tower. + // ListClientSessions returns the set of all client sessions known to + // the db. An optional tower ID can be used to filter out any client + // sessions in the response that do not correspond to this tower. ListClientSessions(*wtdb.TowerID, ...wtdb.ClientSessionListOption) ( map[wtdb.SessionID]*wtdb.ClientSession, error)