Network Privacy API Reference

This section describes the dynamic behaviour of the Network Privacy API using a set of sequence diagrams.

Sequence diagrams

The sequence diagrams in this section describe the behaviour of the Network Privacy API when a licensee has installed and configured a Privacy Controller, Privacy Notifiers or Privacy Q&N Notifiers.

Startup and shutdown sequences

The sequence diagrams in this section describe how the LBS subsystem starts up and shuts down when LBS is built to include a Privacy Protocol Module and privacy requests are received via the Network Privacy API.

Startup sequence

The first request sent into the LBS subsystem via the Network Privacy API starts the subsystem, as shown in figure 1.1 (which shows startup of a licensee Privacy Controller).

Figure 1. Figure 1.1. LBS startup.

Shutdown sequence

The LBS subsystem is shutdown either:

  • When the licensee Network Privacy API client closes its connection and calls the CPosNetworkPrivacy destructor

  • When a timer expires after the last request is completed

Figure 1.2 shows LBS shutdown for the two cases.

Figure 2. Figure 1.2. LBS shutdown

Privacy Controller sequences

The sequence diagrams in this section illustrate the behaviour of the Network Privacy API when a licensee has installed and configured a privacy controller.

Privacy verification with a Privacy Controller (request accepted, rejected or timeout)

Figure 2.1 shows privacy verification with a Privacy Controller.

Figure 3. Figure 2.1 Privacy verification with a Privacy Controller.

Privacy notification with a Privacy Controller

Figure 2.2 shows location notification with a Privacy Controller.

Figure 4. Figure 2.2 Privacy notification with a Privacy Controller.

Privacy verification cancelled with a Privacy Controller

Figure 2.3 shows a privacy verification cancelled with a Privacy Controller.

Figure 5. Figure 2.3. Privacy verification cancelled with Privacy Controller.

Timeout notification with a Privacy Controller

Figure 2.4 shows a timeout notification with a Privacy Controller.

Figure 6. Figure 2.4. Timeout notification with a Privacy Controller.

Privacy Notifier sequences

The sequence diagrams in this section illustrate the behaviour of the Network Privacy API when a licensee has installed and configured privacy notifiers.

Privacy verification with a Privacy Notifier (request accepted, rejected or timeout)

Figure 3.1 shows verification of a privacy request with a Privacy Notifier.

Figure 7. Figure 3.1. Privacy verification with a Privacy Notifier.

Privacy notification with a Privacy Notifier

Figure 3.2 shows location notification with a Privacy Notifier.

Figure 8. Figure 3.2. Privacy notification with a Privacy Notifier.

Privacy verification cancelled with Privacy Notifier

Figure 3.3 shows a privacy verification cancelled with a Privacy Notifier.

Figure 9. Figure 3.3. Privacy verification cancelled with Privacy Notifier.

Timeout notification with Privacy Notifier

Figure 3.4 shows a timeout notification with a Privacy Notifier.

Figure 10. Figure 3.4. Timeout notification with a Privacy Notifier.

Privacy Q&N Notifier sequences

The sequence diagrams in this section illustrate the behaviour of the Network Privacy API when a licensee has installed and configured privacy Q&N notifiers.

Privacy verification with a Privacy Q&N notifier (request accepted, rejected or timeout)

Figure 4.1 shows verification of a privacy request with a Privacy Q&N notifier.

Figure 11. Figure 4.1. Privacy verification with a Q&N Privacy Notifier.

Privacy notification with a Privacy Q&N notifier

Figure 4.2 shows a privacy notification with a Privacy Q&N notifier.

Figure 12. Figure 4.2. Privacy notification with a Privacy Q&N Notifier.

Privacy verification cancelled with Privacy Q&N notifier

Figure 4.3 shows a privacy verification cancelled with a Privacy Q&N notifier.

Figure 13. Figure 4.3. Privacy verification cancelled with Privacy Q&N Notifier.

Timeout notification with Privacy Q&N notifier

Figure 4.4 shows a timeout notification with a Privacy Q&N notifier.

Figure 14. Figure 4.4. Timeout notification with a Privacy Q&N Notifier.