clean up

[matrix_esp_thesis] / src / matrix.h

diff --git a/src/matrix.h b/src/matrix.h
index 81b61702d5a4178288c33f011f79936f8917e75e..226a341152b9e298b2984d0086398d3a6a08540c 100644 (file)
--- a/src/matrix.h
+++ b/src/matrix.h
@@ -149,6 +149,7 @@ MatrixOlmSessionUnpickle(
     void * pickled, int pickledLen,\r
     const void * key, int keyLen);\r
 \r
+// create an olm sesseion from a type 0 message\r
 bool\r
 MatrixOlmSessionFrom(\r
     MatrixOlmSession * session,\r
@@ -157,6 +158,7 @@ MatrixOlmSessionFrom(
     const char * deviceKey,\r
     const char * encrypted);\r
 \r
+// create a new olm session from a claimed onetime key\r
 bool\r
 MatrixOlmSessionTo(\r
     MatrixOlmSession * session,\r
@@ -239,9 +241,6 @@ typedef struct MatrixClient {
     \r
     MatrixDevice devices[NUM_DEVICES];\r
     int numDevices;\r
-    \r
-    // char deviceKey[DEVICE_KEY_SIZE];\r
-    // char signingKey[DEVICE_KEY_SIZE];\r
 \r
     char userId[USER_ID_SIZE];\r
     char accessToken[ACCESS_TOKEN_SIZE];\r
@@ -315,17 +314,6 @@ MatrixClientSendEventEncrypted(
     const char * msgType,\r
     const char * msgBody);\r
 \r
-void\r
-HandleEvent(\r
-    MatrixClient * client,\r
-    const char * event, int eventLen);\r
-\r
-void\r
-HandleRoomEvent(\r
-    MatrixClient * client,\r
-    const char * room, int roomLen,\r
-    const char * event, int eventLen);\r
-\r
 bool\r
 MatrixClientSync(\r
     MatrixClient * client,\r
@@ -346,25 +334,21 @@ MatrixClientShareMegolmOutSession(
     const char * deviceId,\r
     MatrixMegolmOutSession * session);\r
 \r
-bool\r
-MatrixClientShareMegolmOutSessionTest(\r
-    MatrixClient * client,\r
-    const char * userId,\r
-    const char * deviceId,\r
-    MatrixMegolmOutSession * session);\r
-\r
+// try to lookup outgoing megolm session, return true if found\r
 bool\r
 MatrixClientGetMegolmOutSession(\r
     MatrixClient * client,\r
     const char * roomId,\r
     MatrixMegolmOutSession ** outSession);\r
 \r
+// create a new outgoing megolm session and store it locally\r
 bool\r
 MatrixClientNewMegolmOutSession(\r
     MatrixClient * client,\r
     const char * roomId,\r
     MatrixMegolmOutSession ** outSession);\r
 \r
+// try to lookup incoming megolm session, return true if found\r
 bool\r
 MatrixClientGetMegolmInSession(\r
     MatrixClient * client,\r
@@ -372,6 +356,7 @@ MatrixClientGetMegolmInSession(
     const char * sessionId, int sessionIdLen,\r
     MatrixMegolmInSession ** outSession);\r
 \r
+// create a new incoming megolm session and store it locally\r
 bool\r
 MatrixClientNewMegolmInSession(\r
     MatrixClient * client,\r
@@ -379,7 +364,8 @@ MatrixClientNewMegolmInSession(
     const char * sessionId,\r
     const char * sessionKey,\r
     MatrixMegolmInSession ** outSession);\r
-    \r
+\r
+// send a m.room_key_request to the device identified by userId/devideId\r
 bool\r
 MatrixClientRequestMegolmInSession(\r
     MatrixClient * client,\r
@@ -387,8 +373,9 @@ MatrixClientRequestMegolmInSession(
     const char * sessionId,\r
     const char * senderKey,\r
     const char * userId,\r
-    const char * deviceId); // TODO: remove deviceId (query all devices)\r
+    const char * deviceId);\r
 \r
+// try to lookup olm session, return true if found\r
 bool\r
 MatrixClientGetOlmSession(\r
     MatrixClient * client,\r
@@ -396,6 +383,7 @@ MatrixClientGetOlmSession(
     const char * deviceId,\r
     MatrixOlmSession ** outSession);\r
 \r
+// create a new olm session from a type 0 message and store it locally\r
 bool\r
 MatrixClientNewOlmSessionIn(\r
     MatrixClient * client,\r
@@ -403,7 +391,9 @@ MatrixClientNewOlmSessionIn(
     const char * deviceId,\r
     const char * encrypted,\r
     MatrixOlmSession ** outSession);\r
-    \r
+\r
+// create a new olm session with device userId/deviceId and store it locally\r
+// this automatically claims the onetime key\r
 bool\r
 MatrixClientNewOlmSessionOut(\r
     MatrixClient * client,\r
@@ -433,27 +423,33 @@ MatrixClientSendDummy(
     const char * userId,\r
     const char * deviceId);\r
 \r
+// lookup device key locally and if not present get it from server\r
 bool\r
 MatrixClientRequestDeviceKey(\r
     MatrixClient * client,\r
     const char * deviceId,\r
     char * outDeviceKey, int outDeviceKeyCap);\r
     \r
+// lookup signing key locally and if not present get it from server\r
 bool\r
 MatrixClientRequestSigningKey(\r
     MatrixClient * client,\r
     const char * deviceId,\r
     char * outSigningKey, int outSigningKeyCap);\r
 \r
+// lookup the master key for this user and if not present get it from server\r
 bool\r
 MatrixClientRequestMasterKey(\r
     MatrixClient * client,\r
     char * outMasterKey, int outMasterKeyCap);\r
 \r
+// call keys/query and store retrieved information\r
+// this is called by the other Request* functions\r
 bool\r
 MatrixClientRequestDeviceKeys(\r
     MatrixClient * client);\r
 \r
+// delete this device on the server\r
 bool\r
 MatrixClientDeleteDevice(\r
     MatrixClient * client);\r