aboutsummaryrefslogtreecommitdiff
path: root/src/testbed/testbed_api_peers.c
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-02 20:04:17 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 00:44:24 +0100
commit71d3949f6e9889887168784b5f341baa32f791fe (patch)
tree970ab9dc72dbc746700632f06e9715861f423502 /src/testbed/testbed_api_peers.c
parent308d54a985e18dd8765bf9cc394c16a21d2ee456 (diff)
downloadgnunet-71d3949f6e9889887168784b5f341baa32f791fe.tar.gz
gnunet-71d3949f6e9889887168784b5f341baa32f791fe.zip
-DOC: Comment stripping pass in TESTBED subsystem
Diffstat (limited to 'src/testbed/testbed_api_peers.c')
-rw-r--r--src/testbed/testbed_api_peers.c55
1 files changed, 0 insertions, 55 deletions
diff --git a/src/testbed/testbed_api_peers.c b/src/testbed/testbed_api_peers.c
index 99d30e85b..b8e428441 100644
--- a/src/testbed/testbed_api_peers.c
+++ b/src/testbed/testbed_api_peers.c
@@ -661,18 +661,6 @@ GNUNET_TESTBED_peer_start (void *op_cls, struct GNUNET_TESTBED_Peer *peer,
661} 661}
662 662
663 663
664/**
665 * Stop the given peer. The handle remains valid (use
666 * "GNUNET_TESTBED_peer_destroy" to fully clean up the
667 * state of the peer).
668 *
669 * @param op_cls the closure for this operation; will be set in the event
670 * information
671 * @param peer peer to stop
672 * @param pcc function to call upon completion
673 * @param pcc_cls closure for 'pcc'
674 * @return handle to the operation
675 */
676struct GNUNET_TESTBED_Operation * 664struct GNUNET_TESTBED_Operation *
677GNUNET_TESTBED_peer_stop (void *op_cls, 665GNUNET_TESTBED_peer_stop (void *op_cls,
678 struct GNUNET_TESTBED_Peer *peer, 666 struct GNUNET_TESTBED_Peer *peer,
@@ -701,20 +689,6 @@ GNUNET_TESTBED_peer_stop (void *op_cls,
701} 689}
702 690
703 691
704/**
705 * Request information about a peer. The controller callback will not be called
706 * with event type GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
707 * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
708 * be called.
709 * The peer information in the callback is valid until the operation is canceled.
710 *
711 * @param peer peer to request information about
712 * @param pit desired information
713 * @param cb the convenience callback to be called when results for this
714 * operation are available
715 * @param cb_cls the closure for the above callback
716 * @return handle to the operation
717 */
718struct GNUNET_TESTBED_Operation * 692struct GNUNET_TESTBED_Operation *
719GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer, 693GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
720 enum GNUNET_TESTBED_PeerInformationType 694 enum GNUNET_TESTBED_PeerInformationType
@@ -847,20 +821,6 @@ GNUNET_TESTBED_underlay_configure_link (void *op_cls,
847} 821}
848 822
849 823
850/**
851 * Both peers must have been started before calling this function.
852 * This function then obtains a HELLO from 'p1', gives it to 'p2'
853 * and asks 'p2' to connect to 'p1'.
854 *
855 * @param op_cls closure argument to give with the operation event
856 * @param cb the callback to call when this operation has finished
857 * @param cb_cls the closure for the above callback
858 * @param p1 first peer
859 * @param p2 second peer
860 * @return handle to the operation, NULL if connecting these two
861 * peers is fundamentally not possible at this time (peers
862 * not running or underlay disallows)
863 */
864struct GNUNET_TESTBED_Operation * 824struct GNUNET_TESTBED_Operation *
865GNUNET_TESTBED_overlay_connect (void *op_cls, 825GNUNET_TESTBED_overlay_connect (void *op_cls,
866 GNUNET_TESTBED_OperationCompletionCallback cb, 826 GNUNET_TESTBED_OperationCompletionCallback cb,
@@ -957,21 +917,6 @@ oprelease_manage_service (void *cls)
957} 917}
958 918
959 919
960/**
961 * Start or stop given service at a peer. This should not be called to
962 * start/stop the peer's ARM service. Use GNUNET_TESTBED_peer_start(),
963 * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service. Success
964 * or failure of the generated operation is signalled through the controller
965 * event callback and/or operation completion callback.
966 *
967 * @param op_cls the closure for the operation
968 * @param peer the peer whose service is to be started/stopped
969 * @param service_name the name of the service
970 * @param cb the operation completion callback
971 * @param cb_cls the closure for the operation completion callback
972 * @param start 1 to start the service; 0 to stop the service
973 * @return an operation handle; NULL upon error (peer not running)
974 */
975struct GNUNET_TESTBED_Operation * 920struct GNUNET_TESTBED_Operation *
976GNUNET_TESTBED_peer_manage_service (void *op_cls, 921GNUNET_TESTBED_peer_manage_service (void *op_cls,
977 struct GNUNET_TESTBED_Peer *peer, 922 struct GNUNET_TESTBED_Peer *peer,