* @file testbed/testbed_api_peers.h
* @brief internal API to access the 'peers' subsystem
* @author Christian Grothoff
+ * @author Sree Harsha Totakura
*/
+
#ifndef NEW_TESTING_API_PEERS_H
#define NEW_TESTING_API_PEERS_H
/**
- * Details about a peer; kept in a separate struct to avoid bloating
- * memory consumption everywhere...
+ * Enumeration of possible states a peer could be in
*/
-struct PeerDetails
+enum PeerState
{
- /**
- * Configuration of the peer; NULL if we are not sure what the peer's correct
- * configuration actually is; non-NULL if this peer is controlled by this
- * process.
- */
- struct GNUNET_CONFIGURATION_Handle *cfg;
+ /**
+ * State to signify that this peer is invalid
+ */
+ PS_INVALID,
- //PEER_DETAILS
+ /**
+ * The peer has been created
+ */
+ PS_CREATED,
+
+ /**
+ * The peer is running
+ */
+ PS_STARTED,
+
+ /**
+ * The peer is stopped
+ */
+ PS_STOPPED,
};
/**
* A peer controlled by the testing framework. A peer runs
* at a particular host.
- */
+ */
struct GNUNET_TESTBED_Peer
{
/**
* that is responsible for starting/running the peer!).
*/
struct GNUNET_TESTBED_Controller *controller;
-
+
/**
* Which host does this peer run on?
*/
uint32_t unique_id;
/**
- * Internals of the peer for the controlling process; NULL if
- * this process is not controlling this peer.
+ * Peer's state
*/
- struct PeerDetails *details;
-
+ enum PeerState state;
};
struct PeerCreateData
{
/**
- * THe call back to call when we receive peer create success message
+ * The host where the peer has to be created
+ */
+ struct GNUNET_TESTBED_Host *host;
+
+ /**
+ * The template configuration of the peer
+ */
+ const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+ /**
+ * The call back to call when we receive peer create success message
*/
GNUNET_TESTBED_PeerCreateCallback cb;
-
+
/**
* The closure for the above callback
*/
};
+/**
+ * Data for OperationType OP_PEER_START and OP_PEER_STOP
+ */
+struct PeerEventData
+{
+ /**
+ * The handle of the peer to start
+ */
+ struct GNUNET_TESTBED_Peer *peer;
+
+ /**
+ * The Peer churn callback to call when this operation is completed
+ */
+ GNUNET_TESTBED_PeerChurnCallback pcc;
+
+ /**
+ * Closure for the above callback
+ */
+ void *pcc_cls;
+
+};
+
+
/**
* Data for the OperationType OP_PEER_DESTROY;
*/
* The peer whose information has been requested
*/
struct GNUNET_TESTBED_Peer *peer;
-
+
+ /**
+ * The Peer info callback to call when this operation has completed
+ */
+ GNUNET_TESTBED_PeerInfoCallback cb;
+
+ /**
+ * The closure for peer info callback
+ */
+ void *cb_cls;
+
/**
* The type of peer information requested
*/
/**
- * Data for the OperationType OP_PEER_INFO
+ * Data structure for OperationType OP_OVERLAY_CONNECT
*/
-struct PeerInfoData2
+struct OverlayConnectData
{
+
/**
- * The type of peer information requested
+ * Peer A to connect to peer B
*/
- enum GNUNET_TESTBED_PeerInformationType pit;
+ struct GNUNET_TESTBED_Peer *p1;
+
+ /**
+ * Peer B
+ */
+ struct GNUNET_TESTBED_Peer *p2;
+
+ /**
+ * The operation completion callback to call once this operation is done
+ */
+ GNUNET_TESTBED_OperationCompletionCallback cb;
+
+ /**
+ * The closure for the above callback
+ */
+ void *cb_cls;
/**
- * The data from reply
+ * OperationContext for forwarded operations generated when peer1's controller doesn't have the
+ * configuration of peer2's controller for linking laterally to attemp an
+ * overlay connection between peer 1 and peer 2.
*/
- union
- {
+ struct OperationContext *sub_opc;
+
+ /**
+ * State information for this context data
+ */
+ enum OCDState {
+
+ /**
+ * The initial state
+ */
+ OCD_INIT,
+
/**
- * Configuration handle
+ * State where we attempt to acquire peer2's controller's configuration
*/
- struct GNUNET_CONFIGURATION_Handle *cfg;
+ OCD_CFG_ACQUIRE,
/**
- * Peer Identity
+ * State where we link peer1's controller to peer2's controller
*/
- struct GNUNET_PeerIdentity *peer_identity;
- } details;
+ OCD_LINK_CONTROLLERS,
+
+ /**
+ * State where we re-ask controller of peer1 to attempt an overlay connect
+ * between peer1 and peer2
+ */
+ OCD_REATTEMPT_OVERLAY_CONNECT
+ } state;
+
};
+
/**
* Create the given peer at the specified host using the given
* controller. If the given controller is not running on the target
*/
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
- struct GNUNET_TESTBED_Controller *controller,
- struct GNUNET_TESTBED_Host *host,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- GNUNET_TESTBED_PeerCreateCallback cb,
- void *cls);
+ struct GNUNET_TESTBED_Controller
+ *controller,
+ struct GNUNET_TESTBED_Host *host,
+ const struct GNUNET_CONFIGURATION_Handle
+ *cfg, GNUNET_TESTBED_PeerCreateCallback cb,
+ void *cls);
+/**
+ * Generate PeerGetConfigurationMessage
+ *
+ * @param peer_id the id of the peer whose information we have to get
+ * @param operation_id the ip of the operation that should be represented in
+ * the message
+ * @return the PeerGetConfigurationMessage
+ */
+struct GNUNET_TESTBED_PeerGetConfigurationMessage *
+GNUNET_TESTBED_generate_peergetconfig_msg_ (uint32_t peer_id,
+ uint64_t operation_id);
#endif
/* end of testbed_api_peers.h */
projects / oweals / gnunet.git / blobdiff