Skip to content

Commit 3b2773b

Browse files
authored
Fix a typo in the documentation of ntsu::SocketUtil::waitUntilWritable()
1 parent 6512240 commit 3b2773b

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

groups/nts/ntsu/ntsu_socketutil.h

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -683,21 +683,23 @@ struct SocketUtil {
683683
static ntsa::Error remoteEndpoint(ntsa::Endpoint* result,
684684
ntsa::Handle socket);
685685

686-
/// Wait indefinitely until the specified 'socket' is readable. Return
687-
/// the error.
686+
/// Wait indefinitely until the specified 'socket' is readable or the
687+
/// wait is interrupted by a signal. Return the error.
688688
static ntsa::Error waitUntilReadable(ntsa::Handle socket);
689689

690-
/// Wait until the specified 'socket' is readable or the specified
691-
/// absolute 'timeout' elapses. Return the error.
690+
/// Wait until the specified 'socket' is readable or the wait is
691+
/// interrupted by a signal or the specified absolute 'timeout' elapses.
692+
/// Return the error.
692693
static ntsa::Error waitUntilReadable(ntsa::Handle socket,
693694
const bsls::TimeInterval& timeout);
694695

695-
/// Wait indefinitely until the specified 'socket' is readable. Return
696-
/// the error.
696+
/// Wait indefinitely until the specified 'socket' is writable or the
697+
/// wait is interrupted by a signal. Return the error.
697698
static ntsa::Error waitUntilWritable(ntsa::Handle socket);
698699

699-
/// Wait until the specified 'socket' is readable or the specified
700-
/// absolute 'timeout' elapses. Return the error.
700+
/// Wait until the specified 'socket' is writable or the wait is
701+
/// interrupted by a signal or the specified absolute 'timeout' elapses.
702+
/// Return the error.
701703
static ntsa::Error waitUntilWritable(ntsa::Handle socket,
702704
const bsls::TimeInterval& timeout);
703705

0 commit comments

Comments
 (0)