Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduced fix for defect IOTSFW-1058 #79

Merged
merged 2 commits into from
Oct 22, 2015
Merged

Introduced fix for defect IOTSFW-1058 #79

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18dcc91
Introduced fix for defect IOTSFW-1058
Oct 21, 2015
f8e3d2f
Introduced fixes after review
Oct 22, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ble/services/EddystoneConfigService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ class EddystoneConfigService
eddyServ.setTLMFrameData(params.tlmVersion, params.tlmBeaconPeriod);
}
if (params.uriEnabled) {
eddyServ.setURLFrameData(params.advPowerLevels[params.txPowerMode], (const char *) params.uriData, params.uriBeaconPeriod);
eddyServ.setURLFrameEncodedData(params.advPowerLevels[params.txPowerMode], (const char *) params.uriData, params.uriDataLength, params.uriBeaconPeriod);
}
if (params.uidEnabled) {
eddyServ.setUIDFrameData(params.advPowerLevels[params.txPowerMode],
Expand Down
23 changes: 23 additions & 0 deletions ble/services/EddystoneService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,29 @@ class EddystoneService
return false;
}

/**
* Set Eddystone URL Frame information.
* @param[in] power TX Power in dB measured at 0 meters from the device.
* @param[in] url Encoded URL
* @param[in] urlAdvPeriodIn How long to advertise the URL frame (measured in # of adv periods)
* @return false on success, true on failure.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when returning bools, it is more customary to return true on success and false on failure.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason why I left it "false on success, true on failure" is because I used the existing function "bool setURLFrameData(int8_t power, const char *urlIn, uint32_t urlAdvPeriodIn)" as a template. So the return values remain unchanged for consistency in the API.

*/
bool setURLFrameEncodedData(int8_t power, const char *encodedUrlIn, uint8_t encodedUriInLength, uint32_t urlAdvPeriodIn) {
if (0 == urlAdvPeriodIn) {
urlIsSet = false;
return false;
}
defaultUrlPower = power;
memcpy(defaultUriData, encodedUrlIn, URI_DATA_MAX);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would strncpy() be better here? I don't like to use memcpy() because it is unconditional. It might be copying memory which isn't related to the encoded URL. This is not an issue; but just an sanity booster.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this would introduce a bug. Recall that the encoding for ".com/" is 0x0, which is equivalent to "\0" then with the encoding of a URL like "http://mbed.com/hello" the last 5 characters will be dropped. This is because according to the documentation for strncpy():

If the end of the source C string (which is signaled by a null-character) is found before num characters have been copied, destination is padded with zeros until a total of num characters have been written to it.

defaultUriDataLength = encodedUriInLength;
if (defaultUriDataLength > URI_DATA_MAX) {
return true; // error, URL is too big
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the failure case, you've still updated the defaults. Could you do this check before updating the defaults?

}
urlAdvPeriod = urlAdvPeriodIn;
urlIsSet = true;
return false;
}

/*
* Construct URL frame from private variables
* @param[in/out] Data pointer to array to store constructed frame in
Expand Down