summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Smith <git@kismith.co.uk>2015-07-23 16:33:14 (GMT)
committerKevin Smith <kevin.smith@isode.com>2015-08-11 09:21:19 (GMT)
commit360d7d6e0b184fea1d22ba0cc755db6f2e57e889 (patch)
treef6ad4e6b6c1efb00e87e7f68d622aa4f5337beda
parent32dffa31b92ad29cc15cd6e6fe3cc4ef1b4ef23a (diff)
downloadswift-360d7d6e0b184fea1d22ba0cc755db6f2e57e889.zip
swift-360d7d6e0b184fea1d22ba0cc755db6f2e57e889.tar.bz2
Add note on use of Connector::stop()
As the correct API usage might not be obvious Change-Id: I1d4887d7101ce59eb8f3a3dc13d94befe4a58948
-rw-r--r--Swiften/Network/Connector.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/Swiften/Network/Connector.h b/Swiften/Network/Connector.h
index a8b0a2b..f34eaa6 100644
--- a/Swiften/Network/Connector.h
+++ b/Swiften/Network/Connector.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010 Isode Limited.
+ * Copyright (c) 2010-2015 Isode Limited.
* All rights reserved.
* See the COPYING file for more information.
*/
@@ -33,6 +33,11 @@ namespace Swift {
}
void setTimeoutMilliseconds(int milliseconds);
+ /**
+ * Start the connection attempt.
+ * Note that after calling this method, the caller is responsible for calling #stop()
+ * if it wants to cancel it. Not doing so can leak references.
+ */
void start();
void stop();