diff options
author | Christian Grothoff <christian@grothoff.org> | 2014-04-07 09:19:28 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2014-04-07 09:19:28 +0000 |
commit | a740974b42420e5619052d6a13bc3146ddb5a376 (patch) | |
tree | 3f0b0b33417da2189243a0025c8115df2e48af4a /src/core | |
parent | 5fee7ad91f89322863a99cfd3f91a2cd86f51f2e (diff) | |
download | gnunet-a740974b42420e5619052d6a13bc3146ddb5a376.tar.gz gnunet-a740974b42420e5619052d6a13bc3146ddb5a376.zip |
-doxygen improvements
Diffstat (limited to 'src/core')
-rw-r--r-- | src/core/gnunet-service-core_clients.c | 16 | ||||
-rw-r--r-- | src/core/gnunet-service-core_kx.c | 29 | ||||
-rw-r--r-- | src/core/gnunet-service-core_kx.h | 2 | ||||
-rw-r--r-- | src/core/gnunet-service-core_neighbours.c | 4 | ||||
-rw-r--r-- | src/core/gnunet-service-core_sessions.c | 10 |
5 files changed, 31 insertions, 30 deletions
diff --git a/src/core/gnunet-service-core_clients.c b/src/core/gnunet-service-core_clients.c index fa87f82e6..5a30138a0 100644 --- a/src/core/gnunet-service-core_clients.c +++ b/src/core/gnunet-service-core_clients.c | |||
@@ -43,7 +43,7 @@ | |||
43 | 43 | ||
44 | 44 | ||
45 | /** | 45 | /** |
46 | * Data structure for each client connected to the core service. | 46 | * Data structure for each client connected to the CORE service. |
47 | */ | 47 | */ |
48 | struct GSC_Client | 48 | struct GSC_Client |
49 | { | 49 | { |
@@ -64,14 +64,14 @@ struct GSC_Client | |||
64 | 64 | ||
65 | /** | 65 | /** |
66 | * Array of the types of messages this peer cares | 66 | * Array of the types of messages this peer cares |
67 | * about (with "tcnt" entries). Allocated as part | 67 | * about (with @e tcnt entries). Allocated as part |
68 | * of this client struct, do not free! | 68 | * of this client struct, do not free! |
69 | */ | 69 | */ |
70 | const uint16_t *types; | 70 | const uint16_t *types; |
71 | 71 | ||
72 | /** | 72 | /** |
73 | * Map of peer identities to active transmission requests of this | 73 | * Map of peer identities to active transmission requests of this |
74 | * client to the peer (of type 'struct GSC_ClientActiveRequest'). | 74 | * client to the peer (of type `struct GSC_ClientActiveRequest`). |
75 | */ | 75 | */ |
76 | struct GNUNET_CONTAINER_MultiPeerMap *requests; | 76 | struct GNUNET_CONTAINER_MultiPeerMap *requests; |
77 | 77 | ||
@@ -88,7 +88,7 @@ struct GSC_Client | |||
88 | 88 | ||
89 | /** | 89 | /** |
90 | * Number of types of incoming messages this client | 90 | * Number of types of incoming messages this client |
91 | * specifically cares about. Size of the "types" array. | 91 | * specifically cares about. Size of the @e types array. |
92 | */ | 92 | */ |
93 | unsigned int tcnt; | 93 | unsigned int tcnt; |
94 | 94 | ||
@@ -190,7 +190,7 @@ GSC_CLIENTS_send_to_client (struct GNUNET_SERVER_Client *client, | |||
190 | * | 190 | * |
191 | * @param type message type | 191 | * @param type message type |
192 | * @param c client to test | 192 | * @param c client to test |
193 | * @return GNUNET_YES if 'c' is interested, GNUNET_NO if not. | 193 | * @return #GNUNET_YES if @a c is interested, #GNUNET_NO if not. |
194 | */ | 194 | */ |
195 | static int | 195 | static int |
196 | type_match (uint16_t type, struct GSC_Client *c) | 196 | type_match (uint16_t type, struct GSC_Client *c) |
@@ -225,7 +225,7 @@ send_to_all_clients (const struct GNUNET_PeerIdentity *partner, | |||
225 | struct GSC_Client *c; | 225 | struct GSC_Client *c; |
226 | int tm; | 226 | int tm; |
227 | 227 | ||
228 | for (c = client_head; c != NULL; c = c->next) | 228 | for (c = client_head; NULL != c; c = c->next) |
229 | { | 229 | { |
230 | tm = type_match (type, c); | 230 | tm = type_match (type, c); |
231 | if (! ( (0 != (c->options & options)) || | 231 | if (! ( (0 != (c->options & options)) || |
@@ -408,7 +408,7 @@ handle_client_send_request (void *cls, struct GNUNET_SERVER_Client *client, | |||
408 | 408 | ||
409 | 409 | ||
410 | /** | 410 | /** |
411 | * Closure for the 'client_tokenizer_callback'. | 411 | * Closure for the #client_tokenizer_callback(). |
412 | */ | 412 | */ |
413 | struct TokenizerContext | 413 | struct TokenizerContext |
414 | { | 414 | { |
@@ -436,7 +436,7 @@ struct TokenizerContext | |||
436 | * | 436 | * |
437 | * @param cls unused | 437 | * @param cls unused |
438 | * @param client the client issuing the request | 438 | * @param client the client issuing the request |
439 | * @param message the "struct SendMessage" | 439 | * @param message the `struct SendMessage` |
440 | */ | 440 | */ |
441 | static void | 441 | static void |
442 | handle_client_send (void *cls, struct GNUNET_SERVER_Client *client, | 442 | handle_client_send (void *cls, struct GNUNET_SERVER_Client *client, |
diff --git a/src/core/gnunet-service-core_kx.c b/src/core/gnunet-service-core_kx.c index e899b6ded..4a516461f 100644 --- a/src/core/gnunet-service-core_kx.c +++ b/src/core/gnunet-service-core_kx.c | |||
@@ -77,7 +77,7 @@ struct EphemeralKeyMessage | |||
77 | { | 77 | { |
78 | 78 | ||
79 | /** | 79 | /** |
80 | * Message type is CORE_EPHEMERAL_KEY. | 80 | * Message type is #GNUNET_MESSAGE_TYPE_CORE_EPHEMERAL_KEY. |
81 | */ | 81 | */ |
82 | struct GNUNET_MessageHeader header; | 82 | struct GNUNET_MessageHeader header; |
83 | 83 | ||
@@ -128,7 +128,7 @@ struct EphemeralKeyMessage | |||
128 | struct PingMessage | 128 | struct PingMessage |
129 | { | 129 | { |
130 | /** | 130 | /** |
131 | * Message type is CORE_PING. | 131 | * Message type is #GNUNET_MESSAGE_TYPE_CORE_PING. |
132 | */ | 132 | */ |
133 | struct GNUNET_MessageHeader header; | 133 | struct GNUNET_MessageHeader header; |
134 | 134 | ||
@@ -156,7 +156,7 @@ struct PingMessage | |||
156 | struct PongMessage | 156 | struct PongMessage |
157 | { | 157 | { |
158 | /** | 158 | /** |
159 | * Message type is CORE_PONG. | 159 | * Message type is #GNUNET_MESSAGE_TYPE_CORE_PONG. |
160 | */ | 160 | */ |
161 | struct GNUNET_MessageHeader header; | 161 | struct GNUNET_MessageHeader header; |
162 | 162 | ||
@@ -191,7 +191,7 @@ struct PongMessage | |||
191 | struct EncryptedMessage | 191 | struct EncryptedMessage |
192 | { | 192 | { |
193 | /** | 193 | /** |
194 | * Message type is either CORE_ENCRYPTED_MESSAGE. | 194 | * Message type is either #GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE. |
195 | */ | 195 | */ |
196 | struct GNUNET_MessageHeader header; | 196 | struct GNUNET_MessageHeader header; |
197 | 197 | ||
@@ -509,15 +509,15 @@ derive_aes_key (const struct GNUNET_PeerIdentity *sender, | |||
509 | 509 | ||
510 | 510 | ||
511 | /** | 511 | /** |
512 | * Encrypt size bytes from in and write the result to out. Use the | 512 | * Encrypt size bytes from @a in and write the result to @a out. Use the |
513 | * key for outbound traffic of the given neighbour. | 513 | * @a kx key for outbound traffic of the given neighbour. |
514 | * | 514 | * |
515 | * @param kx key information context | 515 | * @param kx key information context |
516 | * @param iv initialization vector to use | 516 | * @param iv initialization vector to use |
517 | * @param in ciphertext | 517 | * @param in ciphertext |
518 | * @param out plaintext | 518 | * @param out plaintext |
519 | * @param size size of in/out | 519 | * @param size size of @a in/@a out |
520 | * @return GNUNET_OK on success | 520 | * @return #GNUNET_OK on success |
521 | */ | 521 | */ |
522 | static int | 522 | static int |
523 | do_encrypt (struct GSC_KeyExchangeInfo *kx, | 523 | do_encrypt (struct GSC_KeyExchangeInfo *kx, |
@@ -549,8 +549,8 @@ do_encrypt (struct GSC_KeyExchangeInfo *kx, | |||
549 | 549 | ||
550 | 550 | ||
551 | /** | 551 | /** |
552 | * Decrypt size bytes from in and write the result to out. Use the | 552 | * Decrypt size bytes from @a in and write the result to @a out. Use the |
553 | * key for inbound traffic of the given neighbour. This function does | 553 | * @a kx key for inbound traffic of the given neighbour. This function does |
554 | * NOT do any integrity-checks on the result. | 554 | * NOT do any integrity-checks on the result. |
555 | * | 555 | * |
556 | * @param kx key information context | 556 | * @param kx key information context |
@@ -609,13 +609,14 @@ send_key (struct GSC_KeyExchangeInfo *kx); | |||
609 | 609 | ||
610 | 610 | ||
611 | /** | 611 | /** |
612 | * Task that will retry "send_key" if our previous attempt failed. | 612 | * Task that will retry #send_key() if our previous attempt failed. |
613 | * | 613 | * |
614 | * @param cls our 'struct GSC_KeyExchangeInfo' | 614 | * @param cls our `struct GSC_KeyExchangeInfo` |
615 | * @param tc scheduler context | 615 | * @param tc scheduler context |
616 | */ | 616 | */ |
617 | static void | 617 | static void |
618 | set_key_retry_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc) | 618 | set_key_retry_task (void *cls, |
619 | const struct GNUNET_SCHEDULER_TaskContext *tc) | ||
619 | { | 620 | { |
620 | struct GSC_KeyExchangeInfo *kx = cls; | 621 | struct GSC_KeyExchangeInfo *kx = cls; |
621 | 622 | ||
@@ -694,7 +695,7 @@ GSC_KX_start (const struct GNUNET_PeerIdentity *pid) | |||
694 | /* peer with "higher" identity starts a delayed KX, if the "lower" peer | 695 | /* peer with "higher" identity starts a delayed KX, if the "lower" peer |
695 | * does not start a KX since he sees no reasons to do so */ | 696 | * does not start a KX since he sees no reasons to do so */ |
696 | kx->retry_set_key_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, | 697 | kx->retry_set_key_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, |
697 | &set_key_retry_task, kx); | 698 | &set_key_retry_task, kx); |
698 | } | 699 | } |
699 | return kx; | 700 | return kx; |
700 | } | 701 | } |
diff --git a/src/core/gnunet-service-core_kx.h b/src/core/gnunet-service-core_kx.h index 4c99669b2..c6b346ec3 100644 --- a/src/core/gnunet-service-core_kx.h +++ b/src/core/gnunet-service-core_kx.h | |||
@@ -118,7 +118,7 @@ GSC_KX_stop (struct GSC_KeyExchangeInfo *kx); | |||
118 | * Initialize KX subsystem. | 118 | * Initialize KX subsystem. |
119 | * | 119 | * |
120 | * @param pk private key to use for the peer | 120 | * @param pk private key to use for the peer |
121 | * @return GNUNET_OK on success, GNUNET_SYSERR on failure | 121 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure |
122 | */ | 122 | */ |
123 | int | 123 | int |
124 | GSC_KX_init (struct GNUNET_CRYPTO_EddsaPrivateKey *pk); | 124 | GSC_KX_init (struct GNUNET_CRYPTO_EddsaPrivateKey *pk); |
diff --git a/src/core/gnunet-service-core_neighbours.c b/src/core/gnunet-service-core_neighbours.c index aa5b6121e..eca5393a2 100644 --- a/src/core/gnunet-service-core_neighbours.c +++ b/src/core/gnunet-service-core_neighbours.c | |||
@@ -531,8 +531,8 @@ GSC_NEIGHBOURS_init () | |||
531 | * | 531 | * |
532 | * @param cls unused | 532 | * @param cls unused |
533 | * @param key peer identity | 533 | * @param key peer identity |
534 | * @param value the 'struct Neighbour' to free | 534 | * @param value the `struct Neighbour` to free |
535 | * @return GNUNET_OK (continue to iterate) | 535 | * @return #GNUNET_OK (continue to iterate) |
536 | */ | 536 | */ |
537 | static int | 537 | static int |
538 | free_neighbour_helper (void *cls, | 538 | free_neighbour_helper (void *cls, |
diff --git a/src/core/gnunet-service-core_sessions.c b/src/core/gnunet-service-core_sessions.c index 4e0ef5e30..5e8bd537f 100644 --- a/src/core/gnunet-service-core_sessions.c +++ b/src/core/gnunet-service-core_sessions.c | |||
@@ -31,6 +31,8 @@ | |||
31 | #include "gnunet-service-core_sessions.h" | 31 | #include "gnunet-service-core_sessions.h" |
32 | #include "gnunet-service-core_clients.h" | 32 | #include "gnunet-service-core_clients.h" |
33 | #include "gnunet_constants.h" | 33 | #include "gnunet_constants.h" |
34 | #include "core.h" | ||
35 | |||
34 | 36 | ||
35 | /** | 37 | /** |
36 | * How often do we transmit our typemap? | 38 | * How often do we transmit our typemap? |
@@ -730,14 +732,13 @@ GSC_SESSIONS_transmit (struct GSC_ClientActiveRequest *car, | |||
730 | 732 | ||
731 | 733 | ||
732 | /** | 734 | /** |
733 | * Helper function for GSC_SESSIONS_handle_client_iterate_peers. | 735 | * Helper function for #GSC_SESSIONS_handle_client_iterate_peers(). |
734 | * | 736 | * |
735 | * @param cls the `struct GNUNET_SERVER_TransmitContext` to queue replies | 737 | * @param cls the `struct GNUNET_SERVER_TransmitContext` to queue replies |
736 | * @param key identity of the connected peer | 738 | * @param key identity of the connected peer |
737 | * @param value the `struct Neighbour` for the peer | 739 | * @param value the `struct Neighbour` for the peer |
738 | * @return GNUNET_OK (continue to iterate) | 740 | * @return #GNUNET_OK (continue to iterate) |
739 | */ | 741 | */ |
740 | #include "core.h" | ||
741 | static int | 742 | static int |
742 | queue_connect_message (void *cls, | 743 | queue_connect_message (void *cls, |
743 | const struct GNUNET_PeerIdentity *key, | 744 | const struct GNUNET_PeerIdentity *key, |
@@ -769,8 +770,7 @@ queue_connect_message (void *cls, | |||
769 | void | 770 | void |
770 | GSC_SESSIONS_handle_client_iterate_peers (void *cls, | 771 | GSC_SESSIONS_handle_client_iterate_peers (void *cls, |
771 | struct GNUNET_SERVER_Client *client, | 772 | struct GNUNET_SERVER_Client *client, |
772 | const struct GNUNET_MessageHeader | 773 | const struct GNUNET_MessageHeader *message) |
773 | *message) | ||
774 | { | 774 | { |
775 | struct GNUNET_MessageHeader done_msg; | 775 | struct GNUNET_MessageHeader done_msg; |
776 | struct GNUNET_SERVER_TransmitContext *tc; | 776 | struct GNUNET_SERVER_TransmitContext *tc; |