Updated comments

This commit is contained in:
nathan 2020-09-29 14:36:53 +02:00
parent e5c35ea24e
commit 61260b02ce
2 changed files with 8 additions and 4 deletions

View File

@ -125,6 +125,10 @@ internal class ResponseManager(private val logger: KLogger, private val actionDi
} }
/** /**
* We only wait for a reply if we are SYNC.
*
* ASYNC does not send a response
*
* @return the result (can be null) or timeout exception * @return the result (can be null) or timeout exception
*/ */
suspend fun waitForReply(responseWaiter: ResponseWaiter, timeoutMillis: Long): Any? { suspend fun waitForReply(responseWaiter: ResponseWaiter, timeoutMillis: Long): Any? {
@ -134,9 +138,9 @@ internal class ResponseManager(private val logger: KLogger, private val actionDi
"RMI waiting: $rmiId" "RMI waiting: $rmiId"
} }
// NOTE: we ALWAYS send a response from the remote end. // NOTE: we ALWAYS send a response from the remote end (except when async).
// //
// 'async' -> DO NOT WAIT // 'async' -> DO NOT WAIT (no response)
// 'timeout > 0' -> WAIT w/ TIMEOUT // 'timeout > 0' -> WAIT w/ TIMEOUT
// 'timeout == 0' -> WAIT FOREVER // 'timeout == 0' -> WAIT FOREVER
if (timeoutMillis > 0) { if (timeoutMillis > 0) {

View File

@ -93,9 +93,9 @@ internal class RmiClient(val isGlobal: Boolean,
// response (even if it is a void response). This simplifies our response mask, and lets us use more bits for storing the // response (even if it is a void response). This simplifies our response mask, and lets us use more bits for storing the
// response ID // response ID
// NOTE: we ALWAYS send a response from the remote end. // NOTE: we ALWAYS send a response from the remote end (except when async).
// //
// 'async' -> DO NOT WAIT // 'async' -> DO NOT WAIT (no response)
// 'timeout > 0' -> WAIT w/ TIMEOUT // 'timeout > 0' -> WAIT w/ TIMEOUT
// 'timeout == 0' -> WAIT FOREVER // 'timeout == 0' -> WAIT FOREVER