diff options
author | Jose <jose@zeroc.com> | 2019-06-14 18:48:48 +0200 |
---|---|---|
committer | Jose <jose@zeroc.com> | 2019-06-14 18:49:09 +0200 |
commit | 8e4bef16230b076621698cedb5a88acc483d7fa5 (patch) | |
tree | e230cd3befb5db467ac0bf108b29c7ce81bd4aab | |
parent | Support for dispatch interceptors (diff) | |
download | ice-8e4bef16230b076621698cedb5a88acc483d7fa5.tar.bz2 ice-8e4bef16230b076621698cedb5a88acc483d7fa5.tar.xz ice-8e4bef16230b076621698cedb5a88acc483d7fa5.zip |
Add doc comments to Communicator SSL related methods
-rw-r--r-- | swift/src/Ice/CommunicatorI.swift | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/swift/src/Ice/CommunicatorI.swift b/swift/src/Ice/CommunicatorI.swift index 4bcda8feacf..5b9fad5698c 100644 --- a/swift/src/Ice/CommunicatorI.swift +++ b/swift/src/Ice/CommunicatorI.swift @@ -268,16 +268,34 @@ public extension Communicator { } } + /// Establish the password prompt object. This must be done before + /// the IceSSL plug-in is initialized. + /// + /// - parameter prompt: `(() -> String)` - The password prompt. func setSslPasswordPrompt(prompt: @escaping (() -> String)) { (self as! CommunicatorI).handle.setSslPasswordPrompt(prompt) } + /// Establish the certificate verifier objet. This must be done before + /// any connection are established. + /// + /// - parameter prompt: `((SSLConnectionInfo) -> Bool)` The certificate verifier. func setSslCertificateVerifier(verifier: @escaping ((SSLConnectionInfo) -> Bool)) { (self as! CommunicatorI).handle.setSslCertificateVerifier { info in verifier(info as! SSLConnectionInfo) } } + /// Initialize the configured plug-ins. The communicator automatically initializes + /// the plug-ins by default, but an application may need to interact directly with + /// a plug-in prior to initialization. In this case, the application must set + /// `Ice.InitPlugins=0` and then invoke `initializePlugins` manually. The plug-ins are + /// initialized in the order in which they are loaded. If a plug-in raises an exception + /// during initialization, the communicator invokes destroy on the plug-ins that have + /// already been initialized. + /// + /// - throws: `InitializationException` Raised if the plug-ins have already been + /// initialized. func initializePlugins() throws { try autoreleasepool { try (self as! CommunicatorI).handle.initializePlugins() |