klasse ara::diag::SovdBulkData

Gebruik

De virtuele functie DeleteAllBulkData van de klasse ara::diag::SovdBulkData wordt aangeroepen om de SOVD-methode “Delete All Bulk Data Defined by Category” uit te voeren [SWS_DM_01855]. De interfacedefinitie is vastgelegd in de header ara/diag/sovd_bulk_data.h AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.1 “DeleteAllBulkData”.

De methode accepteert de volgende overdrachtsparameters:

• bulkDataCategory (ara::core::String): duidt de bulkdatacategorie aan waarvan alle instanties moeten worden gewist [SWS_DM_01855].
• metaInfo (MetaInfo const &): draagt contextgerelateerde meta-informatie van het huidige verzoek over [SWS_DM_01855].
• cancellationHandler (CancellationHandler): informeert over het voortijdig afbreken van de lopende conversatie [SWS_DM_01855].

Het resultaat wordt asynchroon beschikbaar gesteld via een ara::core::Future<DeleteByCategoryResult> [SWS_DM_01855]. Interpretatie: aangezien het opschonen van gehele bulkdatacategorieën tijdrovend kan zijn, zou de applicatie de overgedragen cancellationHandler cyclisch moeten controleren om direct op eventuele afbrekingen te reageren. Vraag Q-59d2847dbe42f240 (open)

Foutafhandeling en uitzonderingsveiligheid

De methode is gedeclareerd als noexcept en uitzonderingsveilig (exception safe) [SWS_DM_01855]. Als het wissen mislukt, moet in de ara::core::Future een passende SOVD-foutcode conform ISO 17978-3 respectievelijk ASAM SOVD 1.1 worden verzonden [SWS_DM_01855].

Concurrency

De thread-safety is voorwaardelijk (conditional): of de implementatie thread-safe of niet-thread-safe moet worden opgezet, wordt bepaald via de aan de constructor overgedragen ConcurrencyType [SWS_DM_01855].

De methode DeleteSpecificBulkData van de interface ara::diag::SovdBulkData wordt aangeroepen om een specifieke bulkdatabron in het kader van de SOVD-methode “Delete Specific Bulk Data Resource” te wissen ([SWS_DM_01856], AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.2 “DeleteSpecificBulkData”). De declaratie vindt plaats via het headerbestand #include "ara/diag/sovd_bulk_data.h".

Bij de aanroep worden de volgende parameters aan de service-implementatie overgedragen:

• bulkDataCategory: duidt de categorie aan van de te wissen bulkdatainstantie.
• bulkDataId: unieke identificator van de specifieke bulkdatabron die moet worden verwijderd.
• metaInfo: draagt aanvullende meta-informatie van het inkomende SOVD-verzoek over.
• cancellationHandler: bewaakt de status van de bewerking en informeert erover indien de lopende conversatie wordt afgebroken.

De operatie werkt asynchroon en retourneert een ara::core::Future<void> ([SWS_DM_01856]). In het geval van een succesvolle verwijdering wordt de future zonder waarde voltooid. Als er tijdens de verwerking een fout optreedt, moet de future worden afgesloten met een toepasselijke SOVD-foutcode volgens ISO 17978-3 respectievelijk ASAM SOVD 1.1 ([SWS_DM_01856]).

Wat betreft gelijktijdigheid is de methode gedeclareerd als noexcept en moet exception safe zijn geïmplementeerd. De vereiste thread-safety is conditioneel: of de functie thread-safe moet worden uitgevoerd, bepaalt de in de constructor overgedragen ConcurrencyType ([SWS_DM_01856]). De implementatie zou moeten waarborgen dat eventuele opruimwerkzaamheden ook bij vroegtijdige melding door de cancellationHandler betrouwbaar plaatsvinden. Vraag Q-2336b99585d8bf3c (open)

De methode ara::diag::SovdBulkData::Offer dient ertoe het doorsturen van diagnoseverzoeken te activeren: door de aanroep wordt het Diagnostic Management (DM) geautoriseerd en in staat gesteld om inkomende request-berichten voor bulkdata door te sturen naar de desbetreffende handler ([SWS_DM_01857]).

Gebruik en semantiek: de functie heeft de signatuur ara::core::Result<void> Offer() noexcept, is parameterloos en garandeert als uitzonderingsveilig (exception safe) dat er geen C++-exceptions worden geworpen ([SWS_DM_01857]). Interpretatie: aangezien het resultaat direct als ara::core::Result<void> en niet via een asynchroon future-object wordt geretourneerd, zou het registratieproces synchroon moeten worden uitgevoerd. Vraag Q-9933248363829009 (open)

Foutafhandeling: bij een mislukken van de registratie retourneert de functie een ara::core::Result met een passende foutcode uit het foutdomein ([SWS_DM_01857]):

• DiagOfferErrc::kAlreadyOffered: de dienst werd voor deze handler al eerder aangeboden ([SWS_DM_01857]; zie ook [SWS_DM_00514] evenals [SWS_DM_00560]).
• DiagOfferErrc::kConfigurationMismatch: de configuratie komt niet overeen met de diagnostische specificatiegegevens (DEXT) ([SWS_DM_01857]).

Beide fouten beschikken over een rollback-semantiek, zodat er bij een fout geen onvolledige registratie achterblijft ([SWS_DM_01857]).

Gelijktijdigheid en wisselwerking: de methode is expliciet gespecificeerd als niet-thread-safe (not thread-safe) ([SWS_DM_01857]). Parallelle aanroepen op dezelfde instantie moeten daarom aan de zijde van de applicatie worden voorkomen. Het activatiepatroon deelt SovdBulkData met andere DM-diensten zoals GenericRoutine ([SWS_DM_00557]), GenericUDSService ([SWS_DM_00619]) of CommunicationControl ([SWS_DM_00809]), die eveneens pas door Offer voor de verwerking van verzoeken worden vrijgegeven.

De virtuele methode RequestBulkDataDownload van de klasse ara::diag::SovdBulkData wordt aangeroepen voor de SOVD-operatie “Download Bulk Data” om het downloaden van bulkdata aan te vragen [SWS_DM_01873]. De declaratie vindt plaats via het headerbestand ara/diag/sovd_bulk_data.h AUTOSAR_AP_SWS_Diagnostics §8.53.1.1.3.5 “RequestBulkDataDownload”.

Als invoerparameters neemt de methode de categorie van de bulkdata (bulkDataCategory), de identificator ervan (bulkDataId), een lijst van geaccepteerde HTTP-headers (acceptHeader), verzoek-meta-informatie (metaInfo) evenals een cancellationHandler over, die informeert over het afbreken van de huidige conversatie [SWS_DM_01873]. De verwerking vindt asynchroon plaats via een ara::core::Future. Deze retourneert een ara::core::Variant, die hetzij een leessessie als tuple van DataTransferReadSession en BulkDataMetaDataDescriptor, hetzij een HTTP-omleiding (HttpRedirect) inkapselt [SWS_DM_01873].

In geval van een fout wordt via de future een passende SOVD-foutcode volgens ISO 17978-3 respectievelijk ASAM SOVD 1.1 door middel van DiagSovdErrc verzonden [SWS_DM_01873]. De functie is gedeclareerd als noexcept en geldt als uitzonderingsveilig (exception safe) [SWS_DM_01873].

Wat betreft gelijktijdigheid is de thread-safety conditioneel (“conditional”): of de methode thread-safe moet worden geïmplementeerd, wordt bepaald door de in de constructor overgedragen ConcurrencyType [SWS_DM_01873]. Interpretatie: als een afbreking via de cancellationHandler wordt gesignaleerd, zou de implementatie lopende voorbereidingen van de gegevensoverdracht voortijdig moeten beëindigen. Vraag Q-1c74be85e810ac8e (open)

Gebruik en aanroepcontext

De zuiver virtuele methode RequestBulkDataUpload van de klasse ara::diag::SovdBulkData wordt door de Diagnostic Server-instantie aangeroepen zodra een client de SOVD-methode “Upload Bulk Data” aanvraagt [SWS_DM_01793]. Zij dient ter voorbereiding van een upload van bulkdata voor een bepaalde datacategorie AUTOSAR AP SWS Diagnostics §8.53.1.1.3.6 “RequestBulkDataUpload”.

Bij de aanroep worden de volgende parameters aan de functie overgedragen [SWS_DM_01854]:

• bulkDataCategory: Duidt de bulkdatacategorie aan waarvoor een nieuwe instantie moet worden geüpload.
• bulkDataMetaData: Descriptor van het type BulkDataMetaDataDescriptor, die vooraf is ingevuld met de beschikbare informatie uit de HTTP-headers van het SOVD-POST-request.
• metaInfo: Aanvullende meta-informatie van het verzoek.
• cancellationHandler: Signaleert wanneer de huidige conversatie wordt afgebroken.

Het retourneren gebeurt asynchroon via een ara::core::Future, die bij succesvolle uitvoering een tuple van een schrijfsessie DataTransferWriteSession en de bijbehorende BulkDataMetaDataDescriptor beschikbaar stelt [SWS_DM_01854].

Foutafhandeling en gelijktijdigheid

Treedt er bij de voorbereiding of uitvoering een fout op, dan wordt via de Future een toepasselijke SOVD-foutcode conform ISO 17978-3 resp. ASAM SOVD 1.1 geretourneerd [SWS_DM_01854]. De functie is gedeclareerd met noexcept en moet uitzonderingsveilig (exception safe) zijn [SWS_DM_01854].

De thread-safety is voorwaardelijk: of de methode thread-safe geïmplementeerd moet zijn, hangt af van de ConcurrencyType die aan de constructor van de instantie is meegegeven [SWS_DM_01854]. Interpretatie: Het zal vermoedelijk de verantwoordelijkheid van de applicatie-implementatie zijn om de overgedragen cancellationHandler tijdens het schrijfproces te monitoren, om bij verbindingsverbrekingen gealloceerde resources van de schrijfsessie tijdig vrij te geven. Vraag Q-cc88a00d48a35d61 (open)

De methode ara::diag::SovdBulkData::StopOffer uit de header ara/diag/sovd_bulk_data.h deactiveert het doorsturen van inkomende verzoekberichten van het Diagnostic Management (DM) naar het desbetreffende object [SWS_DM_01858]. Zij accepteert geen parameters en heeft geen retourwaarde [SWS_DM_01858].

Met betrekking tot uitvoering en veiligheid gelden de volgende voorwaarden:

• Foutafhandeling: de functie is gedeclareerd als noexcept en geclassificeerd als uitzonderingsveilig (exception safe) [SWS_DM_01858]. Er worden noch uitzonderingen geworpen noch foutcodes geretourneerd [SWS_DM_01858].
• Gelijktijdigheid: de operatie is gespecificeerd als niet-thread-safe (not thread-safe) [SWS_DM_01858]. Aanroepen mogen bij parallel gebruik van dezelfde instantie niet onbeschermd worden uitgevoerd.
• Wisselwerking en levenscyclus: de aanroep dient voor de deregistratie respectievelijk beëindiging van de dienstgereedheid. Na de aanroep zouden inkomende verzoeken van het DM niet meer aan de applicatie moeten worden doorgegeven. Vraag Q-23639406c07ca7c1 (open) Dit principe komt overeen met het gestandaardiseerde aanbiedingspatroon voor diagnosehandlers in Adaptive AUTOSAR, zoals dat analoog is gedefinieerd voor functieklassen zoals [SWS_DM_00558] (GenericRoutine), [SWS_DM_00793] (DownloadService) of [SWS_DM_01017] (EcuResetRequest) (vgl. ook AUTOSAR_AP_SWS_Diagnostics §7.3.4.1.2 “Monitors”).