klasse ara::tsync::SynchronizedTimeBaseProvider

Gebruik

De methode RegisterTimeValidationNotification maakt deel uit van de klasse ara::tsync::SynchronizedTimeBaseProvider en wordt via de header #include "ara/tsync/synchronized_time_base_provider.h" geïncludeerd [SWS_TS_01114]. Ze dient ertoe dat time-provider-applicaties tijdsynchronisatieparameters ontvangen [SWS_TS_01114]. Via de parameter timeBaseValidationNotification wordt een referentie doorgegeven naar een notificatie-object van het type ProviderTimeBaseValidationNotification, dat wordt geïnformeerd zodra er een nieuw datablok voor de tijdbasis gereedstaat [SWS_TS_01114]. De methode levert geen retourwaarde op (void) [SWS_TS_01114].

Foutafhandeling

De methode is gedeclareerd als noexcept en bezit de eigenschap exception safe [SWS_TS_01114]. Ze werpt geen uitzonderingen en retourneert geen foutcodes [SWS_TS_01114].

Gelijktijdigheid en beperkingen

Bij het gebruik dienen de volgende restricties in acht te worden genomen:

• Registratiebegrenzing: Er kan maximaal één notifier worden geregistreerd; elke volgende registratie overschrijft de huidige registratie [SWS_TS_01114].
• Thread-safety: De functie is gespecificeerd als non_threadsafe [SWS_TS_01114]. Aanroepen op dezelfde instantie moeten bij parallelle toegang aan applicatiezijde worden gesynchroniseerd.

Samenspel

Terwijl deze functie de registratie aan de zijde van de tijdgever (provider) implementeert [SWS_TS_01114], vormt de klasse ara::tsync::SynchronizedTimeBaseConsumer met RegisterTimeValidationNotification en het type ConsumerTimeBaseValidationNotification de functionele tegenhanger voor tijdverbruikers (consumers) [SWS_TS_01016].

De methode UnregisterTimeValidationNotification van de klasse ara::tsync::SynchronizedTimeBaseProvider wordt via het headerbestand ara/tsync/synchronized_time_base_provider.h beschikbaar gesteld [SWS_TS_01115]. Ze dient voor tijdaanbiederapplicaties (Time Provider Applications) in de context van de tijdsynchronisatie en de acceptatie van tijdsynchronisatieparameters [SWS_TS_01115]; afgaande op de identifier ligt haar doel vermoedelijk in het afmelden van een eerder geregistreerde notificatie voor tijdvalidatie. Vraag Q-49ba26b4b16dd5c7 (open)

Wat betreft aanroepcontext en semantiek gelden de volgende richtlijnen:

• Signatuur en retourwaarde: De functie accepteert geen parameters en heeft geen retourwaarde (void) [SWS_TS_01115].
• Foutafhandeling: De operatie is gedeclareerd als noexcept en gespecificeerd als uitzonderingsveilig (exception safe) [SWS_TS_01115]. Foutcodes of meldingen aan DET of DEM zijn voor deze interface niet voorzien.
• Gelijktijdigheid: De functie is expliciet geclassificeerd als non_threadsafe [SWS_TS_01115]. Parallelle aanroepen op dezelfde instantie van SynchronizedTimeBaseProvider moeten daarom door de aanroeper worden gesynchroniseerd.

In het samenspel van de tijdsynchronisatiearchitectuur bestaat er voor tijdontvangers (Time Consumer Applications) een directe tegenhanger in de klasse ara::tsync::SynchronizedTimeBaseConsumer (gedefinieerd in ara/tsync/synchronized_time_base_consumer.h), die identieke eigenschappen met betrekking tot thread-safety en exception safety vertoont [SWS_TS_01017].

Gebruik

De methode UpdateTime uit de header ara/tsync/synchronized_time_base_provider.h behoort tot de klasse ara::tsync::SynchronizedTimeBaseProvider [SWS_TS_01108]. Ze dient ertoe een nieuwe tijdwaarde voor de klok vast te leggen. De methode accepteert het in te stellen tijdstip timePoint met de templateparameter Duration evenals door de gebruiker gedefinieerde applicatiegegevens userData [SWS_TS_01108]. De klokwaarde wordt daarbij direct lokaal bijgewerkt; de overdracht via de bus vindt pas plaats in de daaropvolgende cyclus [SWS_TS_01108].

Foutafhandeling

De aanroep is gedeclareerd met noexcept en retourneert een ara::core::Result<void> [SWS_TS_01108]. Mocht de lengte van de meegegeven userData de maximaal toegestane grootte overschrijden, die door UserData::kMaxUserDataSize momenteel begrensd is op 3 bytes, dan mislukt de operatie [SWS_TS_01108]. In dat geval levert het Result-object de foutcode TsyncErrc::kInvalidUserDataSize op, waarbij voor het foutgeval geen rollback-semantiek (no_rollback_semantics) is voorzien [SWS_TS_01108].

Gelijktijdigheid en beperkingen

Voor de integratie dient in acht te worden genomen dat UpdateTime als niet thread-safe (non_threadsafe) is gespecificeerd [SWS_TS_01108]. Als instanties van SynchronizedTimeBaseProvider worden gebruikt in gelijktijdige uitvoeringscontexten, moet de aanroepende code voor een geschikte synchronisatie zorgen. De functie garandeert echter uitzonderingsveiligheid (exception safe) [SWS_TS_01108].