From 867402afa58a2530cb628b3eebd52152ff57cafe Mon Sep 17 00:00:00 2001 From: Craig Gidney Date: Sun, 2 Nov 2014 00:14:00 -0400 Subject: [PATCH] Update doc comment in ZrptManager.h // FREEBIE The note about the role parameter was way out of date. --- Signal/src/network/rtp/zrtp/ZrtpManager.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Signal/src/network/rtp/zrtp/ZrtpManager.h b/Signal/src/network/rtp/zrtp/ZrtpManager.h index 6940fadb2..de2c5d3f8 100644 --- a/Signal/src/network/rtp/zrtp/ZrtpManager.h +++ b/Signal/src/network/rtp/zrtp/ZrtpManager.h @@ -32,14 +32,14 @@ } /// Starts a zrtp handshake over the given RtpSocket. -/// The given role type determines if we play the initiator role or the responder role, +/// The CallController's isInitiator state determines if we play the zrtp initiator or responder role, /// All cryptographic keys and settings are either generated on the fly or pulled from the Environment. /// /// @return /// The asynchronous result has type Future(ZrtpHandshakeResult). /// If the handshake completes succesfully, the resulting ZrtpHandshakeResult contains the SrtpSocket to be used for sending audio. -/// If the handshake timeout or otherwise fails to complete, the result will contain a failure. -/// If the handshake is cancelled, the result will contain a failure containing the cancellation token. +/// If the handshake times out, fails to complete, or is cancelled (via the call controller's untilCancelledToken), +/// the returned future will be given a failure. /// /// @param rtpSocket /// The socket to perform the handshake over.