signalapp/Signal-iOS
signalapp/Signal-iOS
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 4 Wiki Activity

Update doc comment in ZrptManager.h // FREEBIE

Browse Source 
The note about the role parameter was way out of date.
This commit is contained in:
Craig Gidney 2014-11-02 00:14:00 -04:00
parent 26d2c2ac42
commit 867402afa5
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Signal/src/network/rtp/zrtp/ZrtpManager.h
View File

@ -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.