Skip to content

Commit 366cab9

Browse files
committed
Clean todo comments in Gap.proto
1 parent 95db65a commit 366cab9

File tree

1 file changed

+2
-17
lines changed

1 file changed

+2
-17
lines changed

services/ble/Gap.proto

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ message AddressWithType
103103
AddressType addressType = 2;
104104
}
105105

106-
// TODO: See if we can merge this with AdvertisementType
107106
message AdvertisingEventType
108107
{
109108
enum AdvertisingEventTypeEnum
@@ -206,25 +205,21 @@ service GapPeripheral
206205

207206
// Allowed in link layer states: standby
208207
// Results in GapPeripheralResponse.StateChanged with state advertising
209-
// TODO: Not all advertising modes may be supported by all servers, document.
210208
rpc Advertise(AdvertisementMode) returns (Nothing) { option (method_id) = 1; }
211209

212210
// Allowed in link layer states: advertising, connected
213211
// Results in GapPeripheralResponse.StateChanged with state standby
214-
// TODO: What if there is a standby transition already ongoing? Then this call will not result in another state change.
215212
rpc Standby(Nothing) returns (Nothing) { option (method_id) = 2; }
216213

217214
// Allowed in link layer states: standby
218215
// Formatting of advertisement data is as per Bluetooth Core Specification.
219-
// TODO: Include ble spec reference
220216
// Maximum advertisement data length for this method is 28 bytes. Server reserves 3 bytes for flags data with the flag bits 'LE General Discoverable Mode' and 'BR/EDR Not Supported' enabled.
221217
// Server will not check validity of the advertisement data and only maximum length of each field will be passed to BLE stack
222218
// If not set by this method, server will have aa advertisement data only flags field.
223219
rpc SetAdvertisementData(AdvertisementData) returns (Nothing) { option (method_id) = 3; }
224220

225221
// Allowed in link layer states: standby
226222
// Formatting of scan response data is as per Bluetooth Core Specification.
227-
// TODO: Include ble spec reference
228223
// Maximum scan response length for this method is 13 bytes. Server reserves 18 bytes for streaming service uuids. Scan Response is only possible with scannable advertisements
229224
// Server will not check validity of the scan response data and only maximum length of each field will be passed to BLE stack
230225
// If not set by this method, server will have as scan response data only service uuids.
@@ -241,20 +236,17 @@ service GapPeripheral
241236
rpc GetIdentityAddress(Nothing) returns (Nothing) { option (method_id) = 6; }
242237

243238
// Allowed in link layer states: standby
244-
// TODO: State default settings
245239
rpc SetSecurityPreferences(SecurityPreference) returns (Nothing) { option (method_id) = 7; }
246240

247241
// Allowed in link layer states: standby
248242
// Default is to allow pairing
249-
// TODO: Explain behavior
250243
rpc SetAllowPairing(BoolValue) returns (Nothing) { option (method_id) = 8; }
251244

252245
// Allowed in link layer states: connected
253246
// Send a slave security request to the master.
254247
// This command has to be issued to notify the master of the security
255248
// requirements of the slave. The master may encrypt the link, initiate the
256249
// pairing procedure, or reject the request.
257-
// TODO: Explain what happens if it clashes with a standby state change
258250
rpc SendSecurityRequest(Nothing) returns (Nothing) { option (method_id) = 9; }
259251

260252
// Allowed in link layer states: standby
@@ -286,16 +278,11 @@ service GapPeripheralResponse
286278

287279
rpc IdentityAddress(AddressWithType) returns(Nothing) { option(method_id) = 4; }
288280

289-
// TODO: What is the use for these calls?
290-
// TODO: Do we get these callbacks also when establishing connection from a bonded peer?
291-
// TODO: Can we merge these two calls into one with a boolean parameter?
281+
292282
rpc PairingSuccessfullyCompleted(Nothing) returns(Nothing) { option(method_id) = 5; }
293283
rpc PairingFailed(PairingStatus) returns(Nothing) { option(method_id) = 6; }
294284

295-
// TODO: State that there are two ways this callback can be triggered:
296-
// by RemoveAllBonds/RemoveOldestBond calls, or when a new bond is created
297-
// TODO: Do we get a call if max bonds is reached and the oldest bond is removed automatically?
298-
// TODO: Clarify what the parameter mean exactly. It is the number of bonds after the change
285+
299286
rpc NumberOfBondsChanged(UInt32Value) returns(Nothing) { option(method_id) = 7; }
300287

301288
rpc BondInformation(BondsStatus) returns(Nothing) { option(method_id) = 8; }
@@ -304,8 +291,6 @@ service GapPeripheralResponse
304291
service GapPeripheralReadiness {
305292
option(service_id) = 36;
306293

307-
// TODO: Clarify when this means: This means GapPeripheral service is ready to be used
308-
// TODO: Do we remove this when we merge with Celllar?
309294
rpc DeviceStarted(Nothing) returns(Nothing) { option(method_id) = 1; }
310295
}
311296

0 commit comments

Comments
 (0)