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/gnunet-service-core_kx.c | |
parent | 5fee7ad91f89322863a99cfd3f91a2cd86f51f2e (diff) | |
download | gnunet-a740974b42420e5619052d6a13bc3146ddb5a376.tar.gz gnunet-a740974b42420e5619052d6a13bc3146ddb5a376.zip |
-doxygen improvements
Diffstat (limited to 'src/core/gnunet-service-core_kx.c')
-rw-r--r-- | src/core/gnunet-service-core_kx.c | 29 |
1 files changed, 15 insertions, 14 deletions
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 | } |