aboutsummaryrefslogtreecommitdiff
path: root/include/olm/olm.h
diff options
context:
space:
mode:
authorMark Haines <mjark@negativecurvature.net>2016-10-25 14:42:10 +0100
committerMark Haines <mjark@negativecurvature.net>2016-10-25 14:42:10 +0100
commit7e9f3bebb8390f975a76c0188ce4cb460fe6692e (patch)
tree6f9946318828921f3dbd1344e0d2672e417af97c /include/olm/olm.h
parent64130c1f8b0a2dd09379ac02544897ad5a2bfb75 (diff)
Document the return values for olm_matches_inbound_session
Diffstat (limited to 'include/olm/olm.h')
-rw-r--r--include/olm/olm.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/olm/olm.h b/include/olm/olm.h
index 3257e53..5764eb2 100644
--- a/include/olm/olm.h
+++ b/include/olm/olm.h
@@ -320,7 +320,8 @@ int olm_session_has_received_message(
/** Checks if the PRE_KEY message is for this in-bound session. This can happen
* if multiple messages are sent to this account before this account sends a
- * message in reply. Returns olm_error() on failure. If the base64
+ * message in reply. Returns 1 if the session matches. Returns 0 if the session
+ * does not match. Returns olm_error() on failure. If the base64
* couldn't be decoded then olm_session_last_error will be "INVALID_BASE64".
* If the message was for an unsupported protocol version then
* olm_session_last_error() will be "BAD_MESSAGE_VERSION". If the message
@@ -333,7 +334,8 @@ size_t olm_matches_inbound_session(
/** Checks if the PRE_KEY message is for this in-bound session. This can happen
* if multiple messages are sent to this account before this account sends a
- * message in reply. Returns olm_error() on failure. If the base64
+ * message in reply. Returns 1 if the session matches. Returns 0 if the session
+ * does not match. Returns olm_error() on failure. If the base64
* couldn't be decoded then olm_session_last_error will be "INVALID_BASE64".
* If the message was for an unsupported protocol version then
* olm_session_last_error() will be "BAD_MESSAGE_VERSION". If the message