IOSAD-143 Docs for [PEPSync createSession:]. IOSAD-143
authorDirk Zimmermann <dz@pep.security>
Tue, 01 Oct 2019 17:12:18 +0200
branchIOSAD-143
changeset 12952908c4ac7c5e
parent 1294 e4560d5853cd
child 1296 201a8b383494
IOSAD-143 Docs for [PEPSync createSession:].
pEpObjCAdapter/PEPSync_Internal.h
     1.1 --- a/pEpObjCAdapter/PEPSync_Internal.h	Tue Oct 01 16:50:28 2019 +0200
     1.2 +++ b/pEpObjCAdapter/PEPSync_Internal.h	Tue Oct 01 17:12:18 2019 +0200
     1.3 @@ -13,8 +13,15 @@
     1.4   Internal methods of PEPSync.
     1.5   */
     1.6  @interface PEPSync : NSObject
     1.7 +
     1.8  /**
     1.9 - Creates an engine session.
    1.10 + Creates an engine session (PEP_SESSION).
    1.11 +
    1.12 + PEPSync is responsible for engine session creation because the engine
    1.13 + has mandatory callback parameters on its init, which PEPSync is managing.
    1.14 +
    1.15 + @param error The usual cocoa error handling.
    1.16 + @return A valid engine PEP_SESSION or NULL if there was an error.
    1.17   */
    1.18  + (PEP_SESSION _Nullable)createSession:(NSError * _Nullable * _Nullable)error;
    1.19