diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-09-25 13:01:06 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-09-25 13:01:06 +0000 |
commit | cd0a4ba7e9518303d132968cbd2090a724940747 (patch) | |
tree | 0abdd234328aa0a5edf3b88b8c704f98f7008500 /src/include/gnunet_testbed_service.h | |
parent | 8079a463fc2d071ac1f7b2fffa55a57cea33e1f5 (diff) | |
download | gnunet-cd0a4ba7e9518303d132968cbd2090a724940747.tar.gz gnunet-cd0a4ba7e9518303d132968cbd2090a724940747.zip |
-doxygen stuff
Diffstat (limited to 'src/include/gnunet_testbed_service.h')
-rw-r--r-- | src/include/gnunet_testbed_service.h | 49 |
1 files changed, 25 insertions, 24 deletions
diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index 33cf464dc..9e8aabeec 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h | |||
@@ -592,7 +592,7 @@ typedef void (*GNUNET_TESTBED_OperationCompletionCallback) (void *cls, | |||
592 | * controller connects to it as a non master controller. The success or failure | 592 | * controller connects to it as a non master controller. The success or failure |
593 | * of this operation will be signalled through the | 593 | * of this operation will be signalled through the |
594 | * GNUNET_TESTBED_ControllerCallback() with an event of type | 594 | * GNUNET_TESTBED_ControllerCallback() with an event of type |
595 | * GNUNET_TESTBED_ET_OPERATION_FINISHED | 595 | * #GNUNET_TESTBED_ET_OPERATION_FINISHED |
596 | * | 596 | * |
597 | * @param op_cls the operation closure for the event which is generated to | 597 | * @param op_cls the operation closure for the event which is generated to |
598 | * signal success or failure of this operation | 598 | * signal success or failure of this operation |
@@ -600,8 +600,8 @@ typedef void (*GNUNET_TESTBED_OperationCompletionCallback) (void *cls, | |||
600 | * @param delegated_host requests to which host should be delegated; cannot be NULL | 600 | * @param delegated_host requests to which host should be delegated; cannot be NULL |
601 | * @param slave_host which host is used to run the slave controller; use NULL to | 601 | * @param slave_host which host is used to run the slave controller; use NULL to |
602 | * make the master controller connect to the delegated host | 602 | * make the master controller connect to the delegated host |
603 | * @param is_subordinate GNUNET_YES if the controller at delegated_host should | 603 | * @param is_subordinate #GNUNET_YES if the controller at delegated_host should |
604 | * be started by the slave controller; GNUNET_NO if the slave | 604 | * be started by the slave controller; #GNUNET_NO if the slave |
605 | * controller has to connect to the already started delegated | 605 | * controller has to connect to the already started delegated |
606 | * controller via TCP/IP | 606 | * controller via TCP/IP |
607 | * @return the operation handle | 607 | * @return the operation handle |
@@ -619,7 +619,7 @@ GNUNET_TESTBED_controller_link (void *op_cls, | |||
619 | * completion of the operation is signalled through the controller_cb from | 619 | * completion of the operation is signalled through the controller_cb from |
620 | * GNUNET_TESTBED_controller_connect(). If the operation is successful the | 620 | * GNUNET_TESTBED_controller_connect(). If the operation is successful the |
621 | * handle to the configuration is available in the generic pointer of | 621 | * handle to the configuration is available in the generic pointer of |
622 | * operation_finished field of struct GNUNET_TESTBED_EventInformation. | 622 | * operation_finished field of `struct GNUNET_TESTBED_EventInformation`. |
623 | * | 623 | * |
624 | * @param op_cls the closure for the operation | 624 | * @param op_cls the closure for the operation |
625 | * @param master the handle to master controller | 625 | * @param master the handle to master controller |
@@ -661,14 +661,14 @@ typedef void (*GNUNET_TESTBED_PeerCreateCallback) (void *cls, | |||
661 | * to the remote host is stopped. | 661 | * to the remote host is stopped. |
662 | * | 662 | * |
663 | * Creating the peer only creates the handle to manipulate and further | 663 | * Creating the peer only creates the handle to manipulate and further |
664 | * configure the peer; use "GNUNET_TESTBED_peer_start" and | 664 | * configure the peer; use #GNUNET_TESTBED_peer_start and |
665 | * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's | 665 | * #GNUNET_TESTBED_peer_stop to actually start/stop the peer's |
666 | * processes. | 666 | * processes. |
667 | * | 667 | * |
668 | * Note that the given configuration will be adjusted by the | 668 | * Note that the given configuration will be adjusted by the |
669 | * controller to avoid port/path conflicts with other peers. | 669 | * controller to avoid port/path conflicts with other peers. |
670 | * The "final" configuration can be obtained using | 670 | * The "final" configuration can be obtained using |
671 | * 'GNUNET_TESTBED_peer_get_information'. | 671 | * #GNUNET_TESTBED_peer_get_information. |
672 | * | 672 | * |
673 | * @param controller controller process to use | 673 | * @param controller controller process to use |
674 | * @param host host to run the peer on; cannot be NULL | 674 | * @param host host to run the peer on; cannot be NULL |
@@ -716,7 +716,7 @@ GNUNET_TESTBED_peer_start (void *op_cls, | |||
716 | 716 | ||
717 | /** | 717 | /** |
718 | * Stop the given peer. The handle remains valid (use | 718 | * Stop the given peer. The handle remains valid (use |
719 | * "GNUNET_TESTBED_peer_destroy" to fully clean up the | 719 | * #GNUNET_TESTBED_peer_destroy to fully clean up the |
720 | * state of the peer). | 720 | * state of the peer). |
721 | * | 721 | * |
722 | * @param op_cls the closure for this operation; will be set in the event | 722 | * @param op_cls the closure for this operation; will be set in the event |
@@ -783,7 +783,7 @@ typedef void (*GNUNET_TESTBED_PeerInfoCallback) (void *cb_cls, | |||
783 | 783 | ||
784 | /** | 784 | /** |
785 | * Request information about a peer. The controller callback will not be called | 785 | * Request information about a peer. The controller callback will not be called |
786 | * with event type GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this | 786 | * with event type #GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this |
787 | * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will | 787 | * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will |
788 | * be called. | 788 | * be called. |
789 | * The peer information in the callback is valid until the operation is canceled. | 789 | * The peer information in the callback is valid until the operation is canceled. |
@@ -792,7 +792,7 @@ typedef void (*GNUNET_TESTBED_PeerInfoCallback) (void *cb_cls, | |||
792 | * @param pit desired information | 792 | * @param pit desired information |
793 | * @param cb the convenience callback to be called when results for this | 793 | * @param cb the convenience callback to be called when results for this |
794 | * operation are available | 794 | * operation are available |
795 | * @param cb_cls the closure for the above callback | 795 | * @param cb_cls the closure for @a cb |
796 | * @return handle to the operation | 796 | * @return handle to the operation |
797 | */ | 797 | */ |
798 | struct GNUNET_TESTBED_Operation * | 798 | struct GNUNET_TESTBED_Operation * |
@@ -840,7 +840,7 @@ GNUNET_TESTBED_peer_destroy (struct GNUNET_TESTBED_Peer *peer); | |||
840 | * @param peer the peer whose service is to be started/stopped | 840 | * @param peer the peer whose service is to be started/stopped |
841 | * @param service_name the name of the service | 841 | * @param service_name the name of the service |
842 | * @param cb the operation completion callback | 842 | * @param cb the operation completion callback |
843 | * @param cb_cls the closure for the operation completion callback | 843 | * @param cb_cls the closure for @a cb |
844 | * @param start 1 to start the service; 0 to stop the service | 844 | * @param start 1 to start the service; 0 to stop the service |
845 | * @return an operation handle; NULL upon error (peer not running) | 845 | * @return an operation handle; NULL upon error (peer not running) |
846 | */ | 846 | */ |
@@ -888,8 +888,8 @@ enum GNUNET_TESTBED_ConnectOption | |||
888 | 888 | ||
889 | /** | 889 | /** |
890 | * Allow or disallow a connection between the specified peers. | 890 | * Allow or disallow a connection between the specified peers. |
891 | * Followed by GNUNET_NO (int) if a connection is disallowed | 891 | * Followed by #GNUNET_NO (int) if a connection is disallowed |
892 | * or GNUNET_YES if a connection is allowed. Note that the | 892 | * or #GNUNET_YES if a connection is allowed. Note that the |
893 | * default (all connections allowed or disallowed) is | 893 | * default (all connections allowed or disallowed) is |
894 | * specified in the configuration of the controller. | 894 | * specified in the configuration of the controller. |
895 | */ | 895 | */ |
@@ -1079,12 +1079,12 @@ GNUNET_TESTBED_underlay_configure_topology (void *op_cls, | |||
1079 | 1079 | ||
1080 | /** | 1080 | /** |
1081 | * Both peers must have been started before calling this function. | 1081 | * Both peers must have been started before calling this function. |
1082 | * This function then obtains a HELLO from 'p1', gives it to 'p2' | 1082 | * This function then obtains a HELLO from @a p1, gives it to @a p2 |
1083 | * and asks 'p2' to connect to 'p1'. | 1083 | * and asks @a p2 to connect to @a p1. |
1084 | * | 1084 | * |
1085 | * @param op_cls closure argument to give with the operation event | 1085 | * @param op_cls closure argument to give with the operation event |
1086 | * @param cb the callback to call when this operation has finished | 1086 | * @param cb the callback to call when this operation has finished |
1087 | * @param cb_cls the closure for the above callback | 1087 | * @param cb_cls the closure for @a cb |
1088 | * @param p1 first peer | 1088 | * @param p1 first peer |
1089 | * @param p2 second peer | 1089 | * @param p2 second peer |
1090 | * @return handle to the operation, NULL if connecting these two | 1090 | * @return handle to the operation, NULL if connecting these two |
@@ -1126,7 +1126,7 @@ typedef void (*GNUNET_TESTBED_TopologyCompletionCallback) (void *cls, | |||
1126 | * be made to achieve the given topology | 1126 | * be made to achieve the given topology |
1127 | * @param comp_cb the completion callback to call when the topology generation | 1127 | * @param comp_cb the completion callback to call when the topology generation |
1128 | * is completed | 1128 | * is completed |
1129 | * @param comp_cb_cls closure for the above completion callback | 1129 | * @param comp_cb_cls closure for the @a comp_cb |
1130 | * @param topo desired underlay topology to use | 1130 | * @param topo desired underlay topology to use |
1131 | * @param va topology-specific options | 1131 | * @param va topology-specific options |
1132 | * @return handle to the operation, NULL if connecting these | 1132 | * @return handle to the operation, NULL if connecting these |
@@ -1241,20 +1241,21 @@ typedef void (*GNUNET_TESTBED_ServiceConnectCompletionCallback) (void *cls, | |||
1241 | * the request is queued to not overwhelm our ability to create and | 1241 | * the request is queued to not overwhelm our ability to create and |
1242 | * maintain connections with other systems. The actual service | 1242 | * maintain connections with other systems. The actual service |
1243 | * handle is then returned via the 'op_result' member in the event | 1243 | * handle is then returned via the 'op_result' member in the event |
1244 | * callback. The 'ca' callback is used to create the connection | 1244 | * callback. The @a ca callback is used to create the connection |
1245 | * when the time is right; the 'da' callback will be used to | 1245 | * when the time is right; the @a da callback will be used to |
1246 | * destroy the connection (upon 'GNUNET_TESTBED_operation_done'). | 1246 | * destroy the connection (upon #GNUNET_TESTBED_operation_done). |
1247 | * 'GNUNET_TESTBED_operation_done' can be used to abort this | 1247 | * #GNUNET_TESTBED_operation_done can be used to abort this |
1248 | * operation until the event callback has been called. | 1248 | * operation until the event callback has been called. |
1249 | * | 1249 | * |
1250 | * @param op_cls closure to pass in operation event // FIXME: didn't we say we'd no longer use the global callback for these? -CG | 1250 | * @param op_cls closure to pass in operation event // FIXME: didn't we say we'd no longer use the global callback for these? -CG |
1251 | * @param peer peer that runs the service | 1251 | * @param peer peer that runs the service |
1252 | * @param service_name name of the service to connect to | 1252 | * @param service_name name of the service to connect to |
1253 | * @param cb the callback to call when this operation finishes | 1253 | * @param cb the callback to call when this operation is ready (that is, |
1254 | * @param cb_cls closure for the above callback | 1254 | * right after the connect adapter returns) |
1255 | * @param cb_cls closure for @a cb | ||
1255 | * @param ca helper function to establish the connection | 1256 | * @param ca helper function to establish the connection |
1256 | * @param da helper function to close the connection | 1257 | * @param da helper function to close the connection |
1257 | * @param cada_cls closure for ca and da | 1258 | * @param cada_cls closure for @a ca and @a da |
1258 | * @return handle for the operation | 1259 | * @return handle for the operation |
1259 | */ | 1260 | */ |
1260 | struct GNUNET_TESTBED_Operation * | 1261 | struct GNUNET_TESTBED_Operation * |