From 92a69e8e650b7350e451af8668e7565347d9e6dd Mon Sep 17 00:00:00 2001 From: Michael Kirk Date: Thu, 2 Feb 2017 15:13:41 -0500 Subject: [PATCH] Repsond to CR w/ @cmchen. * Added docs * added asserts to TSEnv accessors // FREEBIE --- src/Messages/OWSCallAnswerMessage.h | 8 +++++-- src/Messages/OWSCallBusyMessage.h | 8 +++++-- src/Messages/OWSCallBusyMessage.m | 6 ++--- src/Messages/OWSCallHangupMessage.h | 8 +++++-- src/Messages/OWSCallIceUpdateMessage.h | 10 ++++++-- src/Messages/OWSCallOfferMessage.h | 8 +++++-- src/Messages/OWSOutgoingCallMessage.h | 8 +++++-- .../API/Requests/OWSTurnServerInfoRequest.h | 8 +++++-- src/TextSecureKitEnv.m | 24 +++++++++++++++---- 9 files changed, 67 insertions(+), 21 deletions(-) diff --git a/src/Messages/OWSCallAnswerMessage.h b/src/Messages/OWSCallAnswerMessage.h index b411bfdbb..910cb94f5 100644 --- a/src/Messages/OWSCallAnswerMessage.h +++ b/src/Messages/OWSCallAnswerMessage.h @@ -1,10 +1,14 @@ -// Created by Michael Kirk on 12/1/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// NS_ASSUME_NONNULL_BEGIN @class OWSSignalServiceProtosCallMessageAnswer; +/** + * Sent by the call recipient upon accepting a CallOffer + */ @interface OWSCallAnswerMessage : NSObject - (instancetype)initWithCallId:(UInt64)callId sessionDescription:(NSString *)sessionDescription; diff --git a/src/Messages/OWSCallBusyMessage.h b/src/Messages/OWSCallBusyMessage.h index d406d52ff..06d166c05 100644 --- a/src/Messages/OWSCallBusyMessage.h +++ b/src/Messages/OWSCallBusyMessage.h @@ -1,5 +1,6 @@ -// Created by Michael Kirk on 12/1/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "OWSOutgoingCallMessage.h" @@ -7,6 +8,9 @@ NS_ASSUME_NONNULL_BEGIN @class OWSSignalServiceProtosCallMessageBusy; +/** + * Sent by the call recipient after receiving a call offer when they are already in a call. + */ @interface OWSCallBusyMessage : OWSOutgoingCallMessage - (instancetype)initWithCallId:(UInt64)callId; diff --git a/src/Messages/OWSCallBusyMessage.m b/src/Messages/OWSCallBusyMessage.m index af3c104d3..cac55d1ee 100644 --- a/src/Messages/OWSCallBusyMessage.m +++ b/src/Messages/OWSCallBusyMessage.m @@ -1,5 +1,6 @@ -// Created by Michael Kirk on 12/1/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "OWSCallBusyMessage.h" #import "OWSSignalServiceProtos.pb.h" @@ -29,7 +30,6 @@ NS_ASSUME_NONNULL_BEGIN return [builder build]; } - @end NS_ASSUME_NONNULL_END diff --git a/src/Messages/OWSCallHangupMessage.h b/src/Messages/OWSCallHangupMessage.h index b039215bf..4ec22f2fa 100644 --- a/src/Messages/OWSCallHangupMessage.h +++ b/src/Messages/OWSCallHangupMessage.h @@ -1,5 +1,6 @@ -// Created by Michael Kirk on 12/8/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "OWSOutgoingCallMessage.h" @@ -7,6 +8,9 @@ NS_ASSUME_NONNULL_BEGIN @class OWSSignalServiceProtosCallMessageHangup; +/** + * Sent by either party in a call to indicate the user intentionally ended the call. + */ @interface OWSCallHangupMessage : OWSOutgoingCallMessage - (instancetype)initWithCallId:(UInt64)callId; diff --git a/src/Messages/OWSCallIceUpdateMessage.h b/src/Messages/OWSCallIceUpdateMessage.h index 0e13cce9a..e5743ecf3 100644 --- a/src/Messages/OWSCallIceUpdateMessage.h +++ b/src/Messages/OWSCallIceUpdateMessage.h @@ -1,10 +1,16 @@ -// Created by Michael Kirk on 12/6/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// NS_ASSUME_NONNULL_BEGIN @class OWSSignalServiceProtosCallMessageIceUpdate; +/** + * Sent by both parties out of band of the RTC calling channels, as part of setting up those channels. The messages + * include network accessability information from the perspective of each client. Once compatible ICEUpdates have been + * exchanged, the clients can connect directly. + */ @interface OWSCallIceUpdateMessage : NSObject - (instancetype)initWithCallId:(UInt64)callId diff --git a/src/Messages/OWSCallOfferMessage.h b/src/Messages/OWSCallOfferMessage.h index eadef8a15..d8c2c84ac 100644 --- a/src/Messages/OWSCallOfferMessage.h +++ b/src/Messages/OWSCallOfferMessage.h @@ -1,10 +1,14 @@ -// Created by Michael Kirk on 12/1/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// NS_ASSUME_NONNULL_BEGIN @class OWSSignalServiceProtosCallMessageOffer; +/** + * Sent by the call initiator to Signal their intention to set up a call with the recipient. + */ @interface OWSCallOfferMessage : NSObject - (instancetype)initWithCallId:(UInt64)callId sessionDescription:(NSString *)sessionDescription; diff --git a/src/Messages/OWSOutgoingCallMessage.h b/src/Messages/OWSOutgoingCallMessage.h index 71a1cbf90..e74a27db4 100644 --- a/src/Messages/OWSOutgoingCallMessage.h +++ b/src/Messages/OWSOutgoingCallMessage.h @@ -1,5 +1,6 @@ -// Created by Michael Kirk on 12/1/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "TSOutgoingMessage.h" @@ -13,6 +14,9 @@ NS_ASSUME_NONNULL_BEGIN @class TSThread; +/** + * WebRTC call signaling sent out of band, via the Signal Service + */ @interface OWSOutgoingCallMessage : TSOutgoingMessage - (instancetype)initWithThread:(TSThread *)thread offerMessage:(OWSCallOfferMessage *)offerMessage; diff --git a/src/Network/API/Requests/OWSTurnServerInfoRequest.h b/src/Network/API/Requests/OWSTurnServerInfoRequest.h index b6c61615d..1835174f5 100644 --- a/src/Network/API/Requests/OWSTurnServerInfoRequest.h +++ b/src/Network/API/Requests/OWSTurnServerInfoRequest.h @@ -1,10 +1,14 @@ -// Created by Michael Kirk on 11/12/16. -// Copyright © 2016 Open Whisper Systems. All rights reserved. +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "TSRequest.h" NS_ASSUME_NONNULL_BEGIN +/** + * Fetch a list of viable ICE candidates (including TURN and STUN) used for the WebRTC call signaling process. + */ NS_SWIFT_NAME(TurnServerInfoRequest) @interface OWSTurnServerInfoRequest : TSRequest diff --git a/src/TextSecureKitEnv.m b/src/TextSecureKitEnv.m index 0c7215baf..d09cd8f1d 100644 --- a/src/TextSecureKitEnv.m +++ b/src/TextSecureKitEnv.m @@ -1,6 +1,6 @@ -// Created by Frederic Jacobs on 05/12/15. -// Copyright © 2015 Open Whisper Systems. All rights reserved. - +// +// Copyright (c) 2017 Open Whisper Systems. All rights reserved. +// #import "TextSecureKitEnv.h" @@ -44,12 +44,28 @@ static TextSecureKitEnv *TextSecureKitEnvSharedInstance; } } -- (id)contactsManager { +#pragma mark - getters + +- (id)callMessageHandler +{ + NSAssert(_callMessageHandler, @"Trying to access the callMessageHandler before it's set."); + return _callMessageHandler; +} + +- (id)contactsManager +{ NSAssert(_contactsManager, @"Trying to access the contactsManager before it's set."); return _contactsManager; } + +- (id)notificationsManager +{ + NSAssert(_notificationsManager, @"Trying to access the notificationsManager before it's set."); + return _notificationsManager; +} + @end NS_ASSUME_NONNULL_END