Schoumi/BLE_API
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add a comment header for setupService

Browse source
This commit is contained in:
Rohit Grover 2014-11-28 09:39:39 +00:00
parent 077bbb23f7
commit e5145420ba
1 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
services/URIBeacon2Service.h
View file

@ -40,6 +40,24 @@ public:
NUM_POWER_MODES
};
/**
* Singleton factory.
*
* @param[ref] ble
* BLEDevice object for the underlying controller.
* @param[in] urldata
* URI as a null-terminated string.
* @param[in] flagsIn
* UriBeacon Flags.
* @param[in] effectiveTxPowerIn
* UriBeacon Tx Power Level in dBm.
* @param[in] beaconPeriodIn
* The period in milliseconds that a UriBeacon packet is
* transmitted. A value of zero disables UriBeacon
* transmissions.
* @return
* Pointer to the singleton uribeacon service if the initialization goes well; else NULL.
*/
static URIBeacon2Service *setupService(BLEDevice &ble_, const char *urldata, uint8_t flagsIn = 0, int8_t effectiveTxPowerIn = 0, uint16_t beaconPeriodIn = 1000) {
if ((urldata == NULL) || (strlen(urldata) == 0)) {
return NULL;
@ -91,20 +109,6 @@ public:
}
private:
/**
* @param[ref] ble
* BLEDevice object for the underlying controller.
* @param[in] urldata
* URI as a null-terminated string.
* @param[in] flagsIn
* UriBeacon Flags.
* @param[in] effectiveTxPowerIn
* UriBeacon Tx Power Level in dBm.
* @param[in] beaconPeriodIn
* The period in milliseconds that a UriBeacon packet is
* transmitted. A value of zero disables UriBeacon
* transmissions.
*/
URIBeacon2Service(BLEDevice &ble_, const char *urldata, uint8_t flagsIn = 0, int8_t effectiveTxPowerIn = 0, uint16_t beaconPeriodIn = 1000) :
ble(ble_),
payloadIndex(0),