- Timestamp:
- 11/13/09 15:37:02 (14 years ago)
- Files:
-
- 1 modified
Legend:
- Unmodified
- Added
- Removed
-
vtcross/trunk/src/include/vtcross/service_management_layer.h
r465 r518 15 15 */ 16 16 17 /* This header exports the declaration for the Service Management Layer17 /*! This header exports the declaration for the Service Management Layer 18 18 * component. 19 19 */ … … 26 26 27 27 28 /* Service Management Layer (SML) class declaration. The functions listed here 29 * are required by the VTCROSS API for service-oriented VTCROSS radio 30 * architectures. 28 /*! \brief Service Management Layer (SML) class declaration. 29 * 30 * The functions listed here are required by the CROSS API for 31 * service-oriented CROSS radio architectures. Note that most public functions 32 * are documented in the parent class, Component. 31 33 */ 32 34 class ServiceManagementLayer : public Component 33 35 { 34 36 public: 37 /*! \brief Default SML Constructor. */ 35 38 ServiceManagementLayer(); 39 40 /*! \brief Default SML Destructor. */ 36 41 ~ServiceManagementLayer(); 37 42 38 /* Overloaded constructor that creates an SML and connects it to the 43 /*! \brief Preferred SML Constructor. 44 * 45 * Overloaded constructor that creates an SML and connects it to the 39 46 * shell with the passed hostname and port. 40 47 */ … … 42 49 const char* serverPort, int16_t clientPort); 43 50 44 /* Connect and register with the shell component at the passed hostname 51 /*! \brief Connect the SML to a remote Shell control component. 52 * 53 * Connect and register with the shell component at the passed hostname 45 54 * and port. 46 55 */ 47 56 void ConnectToShell(const char* serverName, const char* serverPort); 57 48 58 void SendComponentType(); 49 59 void MessageHandler(int32_t ID); … … 53 63 void DeregisterComponent(); 54 64 55 /* Starts the SML Server and watches it for incoming messages 65 /*! \brief Starts the SML Server and watches it for incoming messages 66 * 67 * TODO 56 68 */ 57 69 void StartSMLServer(); 58 70 59 71 private: 60 /* Receive the radio configuration settings from the shell and pass them 72 /*! \brief Pass the radio configuration onto another component. 73 * 74 * Receive the radio configuration settings from the shell and pass them 61 75 * on to another component. 62 76 */ 63 77 void TransferRadioConfiguration(int32_t ID); 64 78 65 /* Receive information regarding a completed 'experience' and pass it on 79 /*! \brief Pass a radio experience onto another component. 80 * 81 * Receive information regarding a completed 'experience' and pass it on 66 82 * to the appropriate cognitive engine. 67 83 */ 68 84 void TransferExperience(int32_t ID); 69 85 70 /* Listen for other components registering their available services with86 /*! Listen for other components registering their available services with 71 87 * the SML. 72 88 */ … … 74 90 void DeregisterServices(int32_t ID); 75 91 76 /* Change the active mission of the radio to a new one and adjust radio92 /*! Change the active mission of the radio to a new one and adjust radio 77 93 * behavoir appropriately. 78 94 */ 79 95 void SetActiveMission(); 80 96 81 /* TODO97 /*! TODO 82 98 */ 83 99 void RegisterCognitiveEngine(int32_t ID); 84 100 void DeregisterCognitiveEngine(int32_t ID); 85 101 86 /* List all services provided to the radio by registered components.102 /*! List all services provided to the radio by registered components. 87 103 */ 88 104 void ListServices(); 89 105 90 /* Load/Relead the XML configuration file.106 /*! Load/Relead the XML configuration file. 91 107 */ 92 108 void ReloadConfiguration(); 93 109 void LoadConfiguration(const char *SML_Config, Mission* &mList); 94 110 95 /* Create and initialize the DB to hold the services111 /*! Create and initialize the DB to hold the services 96 112 */ 97 113 void CreateServicesDB(); 98 114 void CreateDataDB(); 99 115 100 /* TODO116 /*! TODO 101 117 */ 102 118 void PerformActiveMission(); 103 119 void TransactData(int32_t sourceID); 104 120 105 /* The socket file descriptor information for the shell which this SML121 /*! The socket file descriptor information for the shell which this SML 106 122 * is connected to. 107 123 */ 108 124 int32_t shellSocketFD; 109 125 110 /* TODO126 /*! TODO 111 127 */ 112 128 int16_t CEPort;
