aboutsummaryrefslogtreecommitdiff
path: root/src/psyc/psyc_api.c
diff options
context:
space:
mode:
Diffstat (limited to 'src/psyc/psyc_api.c')
-rw-r--r--src/psyc/psyc_api.c56
1 files changed, 28 insertions, 28 deletions
diff --git a/src/psyc/psyc_api.c b/src/psyc/psyc_api.c
index f85bb7ae8..abe7bb028 100644
--- a/src/psyc/psyc_api.c
+++ b/src/psyc/psyc_api.c
@@ -18,7 +18,7 @@
18 * Boston, MA 02111-1307, USA. 18 * Boston, MA 02111-1307, USA.
19 */ 19 */
20 20
21/** 21/**
22 * @file psyc/psyc_api.c 22 * @file psyc/psyc_api.c
23 * @brief PSYC service; high-level access to the PSYC protocol 23 * @brief PSYC service; high-level access to the PSYC protocol
24 * note that clients of this API are NOT expected to 24 * note that clients of this API are NOT expected to
@@ -46,7 +46,7 @@ struct OperationHandle
46 const struct GNUNET_MessageHeader *msg; 46 const struct GNUNET_MessageHeader *msg;
47}; 47};
48 48
49/** 49/**
50 * Handle to access PSYC channel operations for both the master and slaves. 50 * Handle to access PSYC channel operations for both the master and slaves.
51 */ 51 */
52struct GNUNET_PSYC_Channel 52struct GNUNET_PSYC_Channel
@@ -109,7 +109,7 @@ struct GNUNET_PSYC_Channel
109}; 109};
110 110
111 111
112/** 112/**
113 * Handle for the master of a PSYC channel. 113 * Handle for the master of a PSYC channel.
114 */ 114 */
115struct GNUNET_PSYC_Master 115struct GNUNET_PSYC_Master
@@ -122,7 +122,7 @@ struct GNUNET_PSYC_Master
122}; 122};
123 123
124 124
125/** 125/**
126 * Handle for a PSYC channel slave. 126 * Handle for a PSYC channel slave.
127 */ 127 */
128struct GNUNET_PSYC_Slave 128struct GNUNET_PSYC_Slave
@@ -131,7 +131,7 @@ struct GNUNET_PSYC_Slave
131}; 131};
132 132
133 133
134/** 134/**
135 * Handle that identifies a join request. 135 * Handle that identifies a join request.
136 * 136 *
137 * Used to match calls to #GNUNET_PSYC_JoinCallback to the 137 * Used to match calls to #GNUNET_PSYC_JoinCallback to the
@@ -143,7 +143,7 @@ struct GNUNET_PSYC_JoinHandle
143}; 143};
144 144
145 145
146/** 146/**
147 * Handle for a pending PSYC transmission operation. 147 * Handle for a pending PSYC transmission operation.
148 */ 148 */
149struct GNUNET_PSYC_MasterTransmitHandle 149struct GNUNET_PSYC_MasterTransmitHandle
@@ -156,7 +156,7 @@ struct GNUNET_PSYC_MasterTransmitHandle
156}; 156};
157 157
158 158
159/** 159/**
160 * Handle for a pending PSYC transmission operation. 160 * Handle for a pending PSYC transmission operation.
161 */ 161 */
162struct GNUNET_PSYC_SlaveTransmitHandle 162struct GNUNET_PSYC_SlaveTransmitHandle
@@ -165,7 +165,7 @@ struct GNUNET_PSYC_SlaveTransmitHandle
165}; 165};
166 166
167 167
168/** 168/**
169 * Handle to a story telling operation. 169 * Handle to a story telling operation.
170 */ 170 */
171struct GNUNET_PSYC_Story 171struct GNUNET_PSYC_Story
@@ -435,7 +435,7 @@ disconnect (void *c)
435} 435}
436 436
437 437
438/** 438/**
439 * Start a PSYC master channel. 439 * Start a PSYC master channel.
440 * 440 *
441 * Will start a multicast group identified by the given ECC key. Messages 441 * Will start a multicast group identified by the given ECC key. Messages
@@ -494,7 +494,7 @@ GNUNET_PSYC_master_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
494} 494}
495 495
496 496
497/** 497/**
498 * Stop a PSYC master channel. 498 * Stop a PSYC master channel.
499 * 499 *
500 * @param master PSYC channel master to stop. 500 * @param master PSYC channel master to stop.
@@ -507,7 +507,7 @@ GNUNET_PSYC_master_stop (struct GNUNET_PSYC_Master *mst)
507} 507}
508 508
509 509
510/** 510/**
511 * Function to call with the decision made for a join request. 511 * Function to call with the decision made for a join request.
512 * 512 *
513 * Must be called once and only once in response to an invocation of the 513 * Must be called once and only once in response to an invocation of the
@@ -567,7 +567,7 @@ send_modifier (void *cls, struct GNUNET_ENV_Modifier *mod)
567} 567}
568 568
569 569
570/** 570/**
571 * Send a message to call a method to all members in the PSYC channel. 571 * Send a message to call a method to all members in the PSYC channel.
572 * 572 *
573 * @param mst Handle to the PSYC channel. 573 * @param mst Handle to the PSYC channel.
@@ -610,7 +610,7 @@ GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *mst,
610 GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op); 610 GNUNET_CONTAINER_DLL_insert (ch->transmit_head, ch->transmit_tail, op);
611 611
612 GNUNET_ENV_environment_iterate (env, send_modifier, mst); 612 GNUNET_ENV_environment_iterate (env, send_modifier, mst);
613 613
614 struct GNUNET_PSYC_MasterTransmitHandle *th = GNUNET_malloc (sizeof (*th)); 614 struct GNUNET_PSYC_MasterTransmitHandle *th = GNUNET_malloc (sizeof (*th));
615 th->master = mst; 615 th->master = mst;
616 th->env = env; 616 th->env = env;
@@ -620,7 +620,7 @@ GNUNET_PSYC_master_transmit (struct GNUNET_PSYC_Master *mst,
620} 620}
621 621
622 622
623/** 623/**
624 * Abort transmission request to the channel. 624 * Abort transmission request to the channel.
625 * 625 *
626 * @param th Handle of the request that is being aborted. 626 * @param th Handle of the request that is being aborted.
@@ -633,11 +633,11 @@ GNUNET_PSYC_master_transmit_cancel (struct GNUNET_PSYC_MasterTransmitHandle *th)
633 if (GNUNET_NO != ch->in_transmit) 633 if (GNUNET_NO != ch->in_transmit)
634 return; 634 return;
635 635
636 636
637} 637}
638 638
639 639
640/** 640/**
641 * Join a PSYC channel. 641 * Join a PSYC channel.
642 * 642 *
643 * The entity joining is always the local peer. The user must immediately use 643 * The entity joining is always the local peer. The user must immediately use
@@ -704,7 +704,7 @@ GNUNET_PSYC_slave_join (const struct GNUNET_CONFIGURATION_Handle *cfg,
704} 704}
705 705
706 706
707/** 707/**
708 * Part a PSYC channel. 708 * Part a PSYC channel.
709 * 709 *
710 * Will terminate the connection to the PSYC service. Polite clients should 710 * Will terminate the connection to the PSYC service. Polite clients should
@@ -720,7 +720,7 @@ GNUNET_PSYC_slave_part (struct GNUNET_PSYC_Slave *slv)
720} 720}
721 721
722 722
723/** 723/**
724 * Request a message to be sent to the channel master. 724 * Request a message to be sent to the channel master.
725 * 725 *
726 * @param slave Slave handle. 726 * @param slave Slave handle.
@@ -745,7 +745,7 @@ GNUNET_PSYC_slave_transmit (struct GNUNET_PSYC_Slave *slave,
745} 745}
746 746
747 747
748/** 748/**
749 * Abort transmission request to master. 749 * Abort transmission request to master.
750 * 750 *
751 * @param th Handle of the request that is being aborted. 751 * @param th Handle of the request that is being aborted.
@@ -757,7 +757,7 @@ GNUNET_PSYC_slave_transmit_cancel (struct GNUNET_PSYC_SlaveTransmitHandle *th)
757} 757}
758 758
759 759
760/** 760/**
761 * Convert a channel @a master to a @e channel handle to access the @e channel 761 * Convert a channel @a master to a @e channel handle to access the @e channel
762 * APIs. 762 * APIs.
763 * 763 *
@@ -771,7 +771,7 @@ GNUNET_PSYC_master_get_channel (struct GNUNET_PSYC_Master *master)
771} 771}
772 772
773 773
774/** 774/**
775 * Convert @a slave to a @e channel handle to access the @e channel APIs. 775 * Convert @a slave to a @e channel handle to access the @e channel APIs.
776 * 776 *
777 * @param slave Slave handle. 777 * @param slave Slave handle.
@@ -784,7 +784,7 @@ GNUNET_PSYC_slave_get_channel (struct GNUNET_PSYC_Slave *slave)
784} 784}
785 785
786 786
787/** 787/**
788 * Add a slave to the channel's membership list. 788 * Add a slave to the channel's membership list.
789 * 789 *
790 * Note that this will NOT generate any PSYC traffic, it will merely update the 790 * Note that this will NOT generate any PSYC traffic, it will merely update the
@@ -827,7 +827,7 @@ GNUNET_PSYC_channel_slave_add (struct GNUNET_PSYC_Channel *ch,
827} 827}
828 828
829 829
830/** 830/**
831 * Remove a slave from the channel's membership list. 831 * Remove a slave from the channel's membership list.
832 * 832 *
833 * Note that this will NOT generate any PSYC traffic, it will merely update the 833 * Note that this will NOT generate any PSYC traffic, it will merely update the
@@ -868,7 +868,7 @@ GNUNET_PSYC_channel_slave_remove (struct GNUNET_PSYC_Channel *ch,
868} 868}
869 869
870 870
871/** 871/**
872 * Request to be told the message history of the channel. 872 * Request to be told the message history of the channel.
873 * 873 *
874 * Historic messages (but NOT the state at the time) will be replayed (given to 874 * Historic messages (but NOT the state at the time) will be replayed (given to
@@ -904,7 +904,7 @@ GNUNET_PSYC_channel_story_tell (struct GNUNET_PSYC_Channel *ch,
904} 904}
905 905
906 906
907/** 907/**
908 * Abort story telling. 908 * Abort story telling.
909 * 909 *
910 * This function must not be called from within method handlers (as given to 910 * This function must not be called from within method handlers (as given to
@@ -919,7 +919,7 @@ GNUNET_PSYC_channel_story_tell_cancel (struct GNUNET_PSYC_Story *story)
919} 919}
920 920
921 921
922/** 922/**
923 * Retrieve the best matching channel state variable. 923 * Retrieve the best matching channel state variable.
924 * 924 *
925 * If the requested variable name is not present in the state, the nearest 925 * If the requested variable name is not present in the state, the nearest
@@ -944,7 +944,7 @@ GNUNET_PSYC_channel_state_get (struct GNUNET_PSYC_Channel *channel,
944} 944}
945 945
946 946
947/** 947/**
948 * Return all channel state variables whose name matches a given prefix. 948 * Return all channel state variables whose name matches a given prefix.
949 * 949 *
950 * A name matches if it starts with the given @a name_prefix, thus requesting 950 * A name matches if it starts with the given @a name_prefix, thus requesting
@@ -970,7 +970,7 @@ GNUNET_PSYC_channel_state_get_prefix (struct GNUNET_PSYC_Channel *channel,
970} 970}
971 971
972 972
973/** 973/**
974 * Cancel a state query operation. 974 * Cancel a state query operation.
975 * 975 *
976 * @param query Handle for the operation to cancel. 976 * @param query Handle for the operation to cancel.