diff options
Diffstat (limited to 'src/include/gnunet_psyc_service.h')
-rw-r--r-- | src/include/gnunet_psyc_service.h | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/src/include/gnunet_psyc_service.h b/src/include/gnunet_psyc_service.h index 2bbe8cdd6..de31fe216 100644 --- a/src/include/gnunet_psyc_service.h +++ b/src/include/gnunet_psyc_service.h | |||
@@ -19,20 +19,24 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_psyc_service.h | ||
23 | * @brief PSYC service; high-level access to the PSYC protocol | ||
24 | * note that clients of this API are NOT expected to | ||
25 | * understand the PSYC message format, only the semantics! | ||
26 | * Parsing (and serializing) the PSYC stream format is done | ||
27 | * within the implementation of the libgnunetpsyc library, | ||
28 | * and this API deliberately exposes as little as possible | ||
29 | * of the actual data stream format to the application! | ||
30 | * @author Christian Grothoff | ||
31 | * @author Gabor X Toth | 22 | * @author Gabor X Toth |
23 | * @author Christian Grothoff | ||
24 | * | ||
25 | * @file | ||
26 | * PSYC service | ||
27 | * | ||
28 | * @defgroup psyc PSYC service | ||
29 | * Send/receive messages in PSYC channels and access the PSYC Store. | ||
30 | * | ||
31 | * Note that clients of this API are NOT expected to understand the PSYC message | ||
32 | * format, only the semantics! Parsing (and serializing) the PSYC stream format | ||
33 | * is done within the implementation of the libgnunetpsyc library, and this API | ||
34 | * deliberately exposes as little as possible of the actual data stream format | ||
35 | * to the application! | ||
32 | * | 36 | * |
33 | * NOTE: | 37 | * NOTE: |
34 | * - this API does not know about psyc's "root" and "places"; | 38 | * - this API does not know about PSYC's "root" and "places"; |
35 | * there is no 'root' in GNUnet-Psyc as we're decentralized; | 39 | * there is no 'root' in GNUnet-PSYC as we're decentralized; |
36 | * 'places' and 'persons' are combined within the same | 40 | * 'places' and 'persons' are combined within the same |
37 | * abstraction, that of a "channel". Channels are identified | 41 | * abstraction, that of a "channel". Channels are identified |
38 | * and accessed in this API using a public/private key. | 42 | * and accessed in this API using a public/private key. |
@@ -72,6 +76,8 @@ | |||
72 | * be called 'PSYC-low', whereas a higher-level API | 76 | * be called 'PSYC-low', whereas a higher-level API |
73 | * implementing defaults for standard methods and | 77 | * implementing defaults for standard methods and |
74 | * variables might be called 'PSYC-std' or 'PSYC-high'. | 78 | * variables might be called 'PSYC-std' or 'PSYC-high'. |
79 | * | ||
80 | * @{ | ||
75 | */ | 81 | */ |
76 | 82 | ||
77 | #ifndef GNUNET_PSYC_SERVICE_H | 83 | #ifndef GNUNET_PSYC_SERVICE_H |
@@ -1331,4 +1337,5 @@ GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateRequest *sr); | |||
1331 | 1337 | ||
1332 | /* ifndef GNUNET_PSYC_SERVICE_H */ | 1338 | /* ifndef GNUNET_PSYC_SERVICE_H */ |
1333 | #endif | 1339 | #endif |
1334 | /* end of gnunet_psyc_service.h */ | 1340 | |
1341 | /** @} */ /* end of group */ | ||