DEENESPTFRRUARHIKOZHNL

class ara::sm::s2r::S2RSatellite

[SWS_SM_81002] Upstream: RS_SM_00402

class S2RSatellite {...};

S2RSatellite abstract class.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Forwarding-Header#include "ara/sm/sm_fwd.h"
Scopenamespace ara::sm::s2r

User GuideAI-GENERATED

Receives Suspend-to-RAM notifications for applications for coordinated preparation and resume.
AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: c425edf7dbdd Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

Receives Suspend-to-RAM notifications for applications for coordinated preparation and resume.

The interface ara::sm::s2r::S2RSatellite serves Adaptive Applications as a receiver for Suspend-to-RAM notifications from State Management ([SWS_SM_81002], AUTOSAR_AP_EXP_SWArchitecture §9.2.2.1.4 “Interfaces for Suspend-to-Ram Notifications”). Following initialization and activation via Offer(), the implemented callback functions EnterSuspendMode() and LeaveSuspendMode() are called to asynchronously control application-specific preparations such as data backup or service restarts ([SWS_SM_00710], [SWS_SM_81010], [SWS_SM_81011]). Registration with the central hub strictly requires an appropriately modeled and IAM-authenticated process context ([SWS_SM_00715]).

Context

The abstract base class ara::sm::s2r::S2RSatellite defines the interface for Adaptive Applications to receive notifications for transitioning to and from the \"prepared for Suspend-to-RAM\" state ([SWS_SM_81002], AUTOSAR_AP_EXP_SWArchitecture §9.2.2.1.4 “Interfaces for Suspend-to-Ram Notifications”). While the central S2RHub within State Management controls the coordination of the suspend sequences (AUTOSAR_AP_SWS_StateManagement §7.5.1 “S2R Hub”), the instance of S2RSatellite acts as a local endpoint in the respective application. An Adaptive Application implements the abstract callback functions to perform application-specific preparations such as saving persistent data, stopping offered services, or halting safety-critical activities (AUTOSAR_AP_EXP_SWArchitecture §9.2.2.1.4 “Interfaces for Suspend-to-Ram Notifications”).

S2RKontext app Adaptive Application sat ara::sm::s2r::S2RSatellite app->sat implementiert / instanziiert hub ara::sm::s2r::S2RHub (State Management) sat->hub Offer() / StopOffer() (Registrierung) hub->sat EnterSuspendMode() LeaveSuspendMode() iam Identity & Access Management (IAM) hub->iam checks process context [SWS_SM_00715]

Context diagram: Interaction between Adaptive Application, S2RSatellite, S2RHub, and Identity Access Management. Sources: [SWS_SM_00710], [SWS_SM_00715], AUTOSAR_AP_EXP_SWArchitecture §9.2.2.1.4 “Interfaces for Suspend-to-Ram Notifications”, AUTOSAR_AP_SWS_StateManagement §7.5.1 “S2R Hub”.

Registration and interaction are subject to security checks by Identity and Access Management (IAM): The S2RHub only permits registration if the process context of the satellite matches the configured SuspendToRamSatelliteMapping ([SWS_SM_00715]).

Lifecycle

An instance is created via the explicit constructor S2RSatellite(const ara::core::InstanceSpecifier&) ([SWS_SM_81003]) or via the static factory method Create() ([SWS_SM_81014]). The default constructor is deleted ([SWS_SM_81004]). The class has strict ownership semantics: copy constructor and copy assignment operator are explicitly deleted ([SWS_SM_81007], [SWS_SM_81009]), whereas move constructor and move assignment are permitted, exception-safe, and thread-safe ([SWS_SM_81006], [SWS_SM_81008]).

After instantiation, the object is in the inactive state. Only by calling Offer() does the satellite actively register with the hub and enable the handler calls ([SWS_SM_00710], [SWS_SM_81012]). The satellite remains actively registered until StopOffer() is called ([SWS_SM_00710], [SWS_SM_81013]). Upon destruction via the virtual destructor ~S2RSatellite() ([SWS_SM_81005]), the instance presumably must have been deregistered previously or is implicitly released. Question Q-bbccd3c283007ce8 (open) While constructors and assignments are thread-safe, Offer(), StopOffer(), the destructor, and the handlers are non-thread-safe ([SWS_SM_81003], [SWS_SM_81005], [SWS_SM_81010], [SWS_SM_81011], [SWS_SM_81012], [SWS_SM_81013]).

Usage Path

The regular flow includes provision, processing state changes, and final deregistration:

  1. Provision: The application instantiates its derived satellite class and calls Offer() to establish communication readiness with S2RHub ([SWS_SM_00710], [SWS_SM_81012]).
  2. Suspend request: When State Management triggers a suspend operation ([SWS_SM_00701]), the satellite calls the pure virtual method EnterSuspendMode() ([SWS_SM_00711], [SWS_SM_81010]). The application executes its backup routines and signals readiness asynchronously via the returned ara::core::Future<void> ([SWS_SM_81010]).
  3. Resume request: After waking up, the hub requests leaving the suspend mode ([SWS_SM_00703]). The satellite executes the method LeaveSuspendMode() ([SWS_SM_00711], [SWS_SM_81011]), whereupon the application reactivates services.
  4. Termination: Prior to shutdown, the application calls StopOffer(), whereby the satellite is deregistered from the hub and handlers are deactivated ([SWS_SM_00713], [SWS_SM_81013]).
Nutzungsablauf S2RSatelliteAdaptive ApplicationS2RSatelliteS2RHubUse Case: Initialization and registrationOffer()RegistrierungBestaetigungResult<void> (Erfolg)Use Case: Suspend-PhaseRequestToEnterSuspendModeEnterSuspendMode()Persistieren, Dienste stoppenFuture<void> aufgeloestAntwort bereitUse Case: Resume-PhaseRequestToLeaveSuspendModeLeaveSuspendMode()Dienste reaktivierenFuture<void> aufgeloestAntwort bereitUse Case: DeregistrierungStopOffer()Deregistrierung

Sequence diagram: Typical flow of registration, Suspend-to-RAM notification, resume, and deregistration. Sources: [SWS_SM_00701], [SWS_SM_00703], [SWS_SM_00710], [SWS_SM_00711], [SWS_SM_00713], [SWS_SM_81010], [SWS_SM_81011], [SWS_SM_81012], [SWS_SM_81013].

Error Scenarios

Errors can already occur during instantiation. The static method Create() returns the error ara::sm::SmErrc::kAuthenticationRequired if a forced IAM switch is active; in this case, the parameterized constructor with InstanceSpecifier must be used instead ([SWS_SM_00716], [SWS_SM_81014]). The constructor S2RSatellite(const ara::core::InstanceSpecifier&) checks modeling and platform states and raises runtime violations in case of errors:

  • AraNotInitializedViolation, if the platform runtime environment is not initialized ([SWS_SM_81003]).
  • InstanceSpecifierMappingIntegrityViolation, if the identifier cannot be resolved or does not refer to a PortPrototype ([SWS_SM_81003]).
  • PortInterfaceMappingViolation, if the interface type does not match the expected interface mapping ([SWS_SM_81003]).
  • ProcessMappingViolation, if no matching modeled process exists for the instance reference ([SWS_SM_81003]).
  • InstanceSpecifierAlreadyInUseViolation, if the instance identifier is already in use within the process ([SWS_SM_81003]).

If registration with Offer() fails due to connection issues with the State Management daemon, the call returns a ara::core::Result with the error SmErrc::kOfferFailed ([SWS_SM_81012]). In case of problems during the execution of EnterSuspendMode() or LeaveSuspendMode(), the satellite signals the error SmErrc::kRejected via the returned Future ([SWS_SM_81010], [SWS_SM_81011]). On the hub side, this leads to the overall result kAtLeastOneHadIssuesToLeave when exiting suspend mode ([SWS_SM_00707]).

This guide is based exclusively on the specification documents of AUTOSAR release R25-11.

Member map

Constructors and destructor

2
S2RSatellite~S2RSatellite

Methods

5
CreateEnterSuspendModeLeaveSuspendModeOfferStopOffer

Operators

1
operator=

Class diagram

Hohle Dreieckspfeile = Vererbung (zeigt zur Basisklasse); Klicken öffnet die jeweilige Klassenseite.

G nara__sm__s2r__S2RSatellite502 S2RSatellite + S2RSatellite() + operator=() + ~S2RSatellite() + Create() + EnterSuspendMode() + LeaveSuspendMode() + Offer() + StopOffer()

Detail view

Select an entry in the outline.

Constructors and destructor

S2RSatellite function 4

Creation of an S2RSatellite.

Overloads S2RSatellite 4
explicit S2RSatellite (const ara::core::InstanceSpecifier &instance) noexcept; SWS_SM_81003
S2RSatellite ()=delete; SWS_SM_81004
S2RSatellite (S2RSatellite &&ra) noexcept; SWS_SM_81006
S2RSatellite (const S2RSatellite &)=delete; SWS_SM_81007
~S2RSatellite function

Destructor for S2RSatellite.

virtual ~S2RSatellite () noexcept;

Methods

Create function

Creation of an conneting directly to S2RHub within the current machine.

static ara::core::Result< S2RSatellite > Create () noexcept;
EnterSuspendMode function

EnterSuspendMode is called to enter Suspend Mode. The handler invocation needs to be enabled before by a call of Offer().

virtual ara::core::Future< void > EnterSuspendMode ()=0;
LeaveSuspendMode function

LeaveSuspendMode is called to leave Suspend Mode. The handler invocation needs to be enabled before by a call of Offer().

virtual ara::core::Future< void > LeaveSuspendMode ()=0;
Offer function

Enables potential invocations of handlers .

ara::core::Result< void > Offer () noexcept;
StopOffer function

Disables invocations of handlers.

void StopOffer () noexcept;

Operators

operator= function 2

Move assignment operator for S2RSatellite.

Overloads = 2
S2RSatellite & operator= (S2RSatellite &&ra) noexcept; SWS_SM_81008
S2RSatellite & operator= (const S2RSatellite &)=delete; SWS_SM_81009

Method documentation

function Create [SWS_SM_81014] Upstream: RS_SM_00402

static ara::core::Result< S2RSatellite > Create () noexcept;

Creation of an conneting directly to S2RHub within the current machine.

AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: ee8ec5327419 Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

use

The static factory method ara::sm::s2r::S2RSatellite::Create serves for the synchronous instantiation of a satellite for direct connection to the S2RHub within the same machine ([SWS_SM_81014]). The call takes no parameters and returns a ara::core::Result<S2RSatellite>, which provides the created satellite object in case of success ([SWS_SM_81014]).

Error handling

If the configuration switch “Force IAM switch” is set to true, the call fails and returns the error code ara::sm::SmErrc::kAuthenticationRequired ([SWS_SM_00716]). In this case, the constructor ara::sm::s2r::S2RSatellite::S2RSatellite must mandatorily be used instead ([SWS_SM_81014]). In addition, a AraNotInitialized-Violation is triggered if the ARA runtime environment is not initialized at the time of the call ([SWS_SM_81014]).

Concurrency and Constraints

The function is specified as thread-safe as well as exception-safe and declared with noexcept ([SWS_SM_81014]). It can thus be called safely from concurrent application contexts.

Interaction

Instances of S2RSatellite are used in S2R-capable applications to process notifications before and after suspend mode (SWS StateManagement §7.5.2 “S2R Satellite”). After successful instantiation, the application registers with the hub via Offer ([SWS_SM_00710]). Before destroying the object, deregistration must be called by means of StopOffer ([SWS_SM_00713]). Interpretation: The method Create is likely intended primarily for application scenarios in which no IAM authentication is forced for the satellite. Question Q-fc41980edcb3f61a (open)

This usage note was created by an AI.

Implementer's Guide to follow (complexity I1)

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitthread-safe
Verletzungen (Violations)AraNotInitialized- Violation message that is sent in case a constructor or function Violation checks for an initialized ara and identifies that ara is not initialized.

Rückgabewert

TypBeschreibung
ara::core::Result< S2RSatellite >a result that contains either a object or an error.

Fehler

FehlercodeBeschreibung
ara::sm::SmErrc::kAuthenticationRequiredrollback_semantics S2R Satellite requires IAM authentication. ara::sm::s2r:: S2RSatellite::S2RSatellite has to be used instead.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81014
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81014@rel:R25-11#cd8a5e9e
Content hash
cd8a5e9e
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81014
Status: valid/unmigrated Version: rel:R25-11#cd8a5e9e Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81014@rel:R25-11#cd8a5e9e
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function EnterSuspendMode [SWS_SM_81010] Upstream: RS_SM_00402

virtual ara::core::Future< void > EnterSuspendMode ()=0;

EnterSuspendMode is called to enter Suspend Mode. The handler invocation needs to be enabled before by a call of Offer().

AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: 023b44de9187 Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

The pure virtual callback method EnterSuspendMode of class ara::sm::s2r::S2RSatellite [SWS_SM_81010] requests a satellite instance to enter suspend mode [SWS_SM_00711]. The call is initiated when the S2R Hub instructs all actively registered satellites via RequestToEnterSuspendMode to transition to the suspend state [SWS_SM_00701]. A prerequisite for receiving this call is that the satellite instance was previously successfully registered with the hub via Offer [SWS_SM_81010] [SWS_SM_00710].

ara::core::Future<void> serves as the return value [SWS_SM_81010]. If the application can successfully enter suspend mode, the future is fulfilled with void [SWS_SM_81010]. If an error occurs, the future must be completed with the error code SmErrc::kRejected [SWS_SM_81010]. If at least one satellite reports kRejected, the hub request returns the overall result kAtLeastOneRejected [SWS_SM_00702]. If a satellite does not respond in time within the timeout, communication is aborted with the error kCommunicationTimeout AUTOSAR_AP_SWS_StateManagement p. 36.

Regarding concurrency, the interface is defined as not thread-safe (not-threadsafe) and not exception-safe (not exception safe) [SWS_SM_81010]. Before destroying the satellite object, StopOffer must be called; this call unregisters the satellite and blocks until running callback executions are finished [SWS_SM_00713]. Since the method is declared as pure virtual, the concrete implementation is likely done in a derived application class in order to persist local states before suspend-to-RAM. Question Q-628b88828075652c (open)

This text was generated by an AI system based on the AUTOSAR R25-11 specification.

Implementer's Guide to follow (complexity I1)

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitnot exception safe
Thread-Sicherheitnot-threadsafe

Rückgabewert

TypBeschreibung
ara::core::Future< void >void in case the Suspend Mode is successfully entered; or the error kRejected if there is an issue to enter Suspend Mode.

Fehler

FehlercodeBeschreibung
SmErrc::kRejectedrollback_semantics There are issues to enter Suspend Mode.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81010
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81010@rel:R25-11#4ccf8b3e
Content hash
4ccf8b3e
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81010
Status: valid/unmigrated Version: rel:R25-11#4ccf8b3e Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81010@rel:R25-11#4ccf8b3e
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function LeaveSuspendMode [SWS_SM_81011] Upstream: RS_SM_00402

virtual ara::core::Future< void > LeaveSuspendMode ()=0;

LeaveSuspendMode is called to leave Suspend Mode. The handler invocation needs to be enabled before by a call of Offer().

AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: 4c7954c5f9b4 Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

The pure virtual method LeaveSuspendMode serves S2R-capable applications (S2R-Aware applications) to exit suspend mode and resume regular operation [SWS_SM_81011], SWS StateManagement §7.5.2 “S2R Satellite”. As an interpretation, the application-specific resume logic is likely implemented in a class derived from ara::sm::s2r::S2RSatellite. Question Q-c8e12bf51d76935c (open)

Usage and Call Context

The call is asynchronous and is initiated by receiving a resume trigger at the satellite [SWS_SM_00711]. This trigger originates from ara::sm::s2r::S2RHub::RequestToLeaveSuspendMode, which sends a message to all actively registered satellite instances [SWS_SM_00703]. The method expects no parameters and returns a ara::core::Future<void> [SWS_SM_81011]. In the success case, the future is fulfilled with void as soon as suspend mode has been exited successfully [SWS_SM_81011].

Error handling

If problems occur during wakeup, the future fails with the error code SmErrc::kRejected (rollback semantics) [SWS_SM_81011]. This causes the S2R hub to output kAtLeastOneHadIssuesToLeave as the overall result [SWS_SM_00707]. If a satellite does not react within the specified time limit, the hub aborts with kCommunicationTimeout [SWS_SM_00707].

Concurrency and preconditions

  • Registration: Handler activation requires that Offer was called previously [SWS_SM_81011], whereby the satellite is actively registered [SWS_SM_00710].
  • Safety: The operation is specified as not-threadsafe and not exception safe [SWS_SM_81011].
  • Lifecycle: Before destroying the satellite, StopOffer must be called; the call blocks until running callbacks are completed [SWS_SM_00713].

This usage note was generated automatically and is based exclusively on the specification data of AUTOSAR Adaptive R25-11.

Implementer's Guide to follow (complexity I1)

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitnot exception safe
Thread-Sicherheitnot-threadsafe

Rückgabewert

TypBeschreibung
ara::core::Future< void >void in case the Suspend Mode is left; or the error kRejected if the resume is not successful.

Fehler

FehlercodeBeschreibung
SmErrc::kRejectedrollback_semantics There are issues to leave Suspend Mode.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81011
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81011@rel:R25-11#121e27da
Content hash
121e27da
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81011
Status: valid/unmigrated Version: rel:R25-11#121e27da Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81011@rel:R25-11#121e27da
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function Offer [SWS_SM_81012] Upstream: RS_SM_00402

ara::core::Result< void > Offer () noexcept;

Enables potential invocations of handlers .

AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: 4698b0d80386 Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

The synchronous member function ara::sm::s2r::S2RSatellite::Offer registers a satellite instance with the central S2R hub [SWS_SM_00710]. The parameterless call activates the reception of notifications so that application-side callbacks for the transition into suspend mode as well as waking up again can be invoked [SWS_SM_81012], [SWS_SM_81010], [SWS_SM_81011]. The method returns a ara::core::Result<void> and is declared as exception safe (noexcept) [SWS_SM_81012].

In the regular case of success, the returned Result is empty [SWS_SM_81012]. If the service cannot be provided due to disrupted communication with the State Management daemon, the call fails with error code SmErrc::kOfferFailed [SWS_SM_81012]. In addition, the process context of the satellite must conform to the IAM requirements for the registered application, as unauthorized instances are rejected [SWS_SM_00715]. Interpretation: If registration fails, the instance is likely to remain unregistered with the hub. Question Q-1b445bcf1aecef2d (open)

With regard to concurrency, Offer is specified as not thread-safe (not thread-safe) [SWS_SM_81012]; parallel calls on the same instance therefore require external synchronization. After successful offering, the satellite remains actively registered until the application explicitly calls ara::sm::s2r::S2RSatellite::StopOffer [SWS_SM_00710]. Deregistration via StopOffer must occur before destruction of the satellite and blocks until running callbacks are completed [SWS_SM_00713].

This text was generated by an AI and serves as guidance. Only the specifications of AUTOSAR are binding.

Implementer's Guide to follow (complexity I1)

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitnot thread-safe

Rückgabewert

TypBeschreibung
ara::core::Result< void >A Result, being either empty or containing any of the errors defined below.

Fehler

FehlercodeBeschreibung
SmErrc::kOfferFailedrollback_semantics Service could not be offered due to failure of communication with Sm daemon

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81012
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81012@rel:R25-11#a19ccbb6
Content hash
a19ccbb6
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81012
Status: valid/unmigrated Version: rel:R25-11#a19ccbb6 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81012@rel:R25-11#a19ccbb6
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function S2RSatellite [SWS_SM_81003] Upstream: RS_SM_00402

explicit S2RSatellite (const ara::core::InstanceSpecifier &instance) noexcept;

Creation of an S2RSatellite.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitthread-safe
Verletzungen (Violations)InstanceSpeci- InstanceSpecifier either cannot be resolved in the model in the fierMappingIn- context of your executable, or it refers to a model element other tegrityViolation than a PortPrototype. PortInterfaceMap- The type of mapping does not match the expected type of Port pingViolation Interface: {portInterfaceTypeName} referenced by a {mappingType Name}. ProcessMappingVio- Matching InstanceRef exists, but no matching (modelled) Process lation found that matches the (runtime) process. InstanceSpecifier- Violation message that is sent in case a constructor in the ara AlreadyInUseViola- framework was called with an InstanceSpecifier already in use in tion this process. AraNotInitialized- Violation message that is sent in case a constructor or function Violation checks for an initialized ara and identifies that ara is not initialized.

Parameter (in)

ParameterBeschreibung
instanceinstance specifier to the PPortPrototype of a SuspendToRamSatelliteInterface

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81003
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81003@rel:R25-11#00c86d21
Content hash
00c86d21
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81003
Status: valid/unmigrated Version: rel:R25-11#00c86d21 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81003@rel:R25-11#00c86d21
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function S2RSatellite [SWS_SM_81004] Upstream: RS_SM_00402

S2RSatellite ()=delete;

Default constructor for S2RSatellite shall not be used.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81004
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81004@rel:R25-11#5d3b2368
Content hash
5d3b2368
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81004
Status: valid/unmigrated Version: rel:R25-11#5d3b2368 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81004@rel:R25-11#5d3b2368
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function S2RSatellite [SWS_SM_81006] Upstream: RS_SM_00402

S2RSatellite (S2RSatellite &&ra) noexcept;

Move constructor for S2RSatellite.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitthread-safe

Parameter (in)

ParameterBeschreibung
raThe S2RSatellite object to be moved.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81006
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81006@rel:R25-11#00250293
Content hash
00250293
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81006
Status: valid/unmigrated Version: rel:R25-11#00250293 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81006@rel:R25-11#00250293
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function S2RSatellite [SWS_SM_81007] Upstream: RS_SM_00402

S2RSatellite (const S2RSatellite &)=delete;

The copy constructor for S2RSatellite shall not be used.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81007
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81007@rel:R25-11#c1967e7f
Content hash
c1967e7f
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81007
Status: valid/unmigrated Version: rel:R25-11#c1967e7f Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81007@rel:R25-11#c1967e7f
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function StopOffer [SWS_SM_81013] Upstream: RS_SM_00402

void StopOffer () noexcept;

Disables invocations of handlers.

AI-GENERATED unreviewed Model: gemini-3.8-flash-medium · Effort: medium · Temperature: not controllable · Prompt: f065eb564bf8 Provenance Open questions (1)
translated from the German guidegemini-3.8-flash-low · 2026-10-13 · German original

Usage and Semantics

The method StopOffer() deregisters an instance of ara::sm::s2r::S2RSatellite at S2R Hub and deactivates future callback invocations ([SWS_SM_81013], [SWS_SM_00710]). The call is synchronous and blocks until all currently active callback executions are completely finished ([SWS_SM_00713]). The function takes no parameters and has no return value.

Lifecycle and Error Handling

The interface is declared as noexcept and throws no exceptions; specific error codes do not exist ([SWS_SM_81013]). According to the specification, StopOffer() is not thread-safe (not thread-safe). The application must ensure that StopOffer() is called either explicitly before destruction of the S2RSatellite object or—Interpretation: presumably—executed within the destructor of the encapsulating user class (SWS StateManagement §7.5.2 “Deregistration of S2R Satellites at S2R Hub”). Question Q-79aa369fb23871ed (open)

Interaction in the Suspend-to-RAM Sequence

If the S2R Hub is executing RequestToEnterSuspendMode or RequestToLeaveSuspendMode, it waits for all addressed satellites. If a satellite deregisters via StopOffer() during this phase, this is treated by the hub like a positive acknowledgment and prevents a failure of the state change ([SWS_SM_00702], [SWS_SM_00707]).

This usage note was automatically created based on AUTOSAR specification R25-11.

Implementer's Guide to follow (complexity I1)

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitnot thread-safe

Rückgabewert

TypBeschreibung
None

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81013
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81013@rel:R25-11#b565557d
Content hash
b565557d
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81013
Status: valid/unmigrated Version: rel:R25-11#b565557d Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81013@rel:R25-11#b565557d
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function operator= [SWS_SM_81008] Upstream: RS_SM_00402

S2RSatellite & operator= (S2RSatellite &&ra) noexcept;

Move assignment operator for S2RSatellite.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitthread-safe

Parameter (in)

ParameterBeschreibung
raThe S2RSatellite object to be moved.

Rückgabewert

TypBeschreibung
S2RSatellite &The moved S2RSatellite object.

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81008
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81008@rel:R25-11#b5e55d29
Content hash
b5e55d29
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81008
Status: valid/unmigrated Version: rel:R25-11#b5e55d29 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81008@rel:R25-11#b5e55d29
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function operator= [SWS_SM_81009] Upstream: RS_SM_00402

S2RSatellite & operator= (const S2RSatellite &)=delete;

The copy assignment operator for S2RSatellite shall not be used.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81009
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81009@rel:R25-11#f0c4993d
Content hash
f0c4993d
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81009
Status: valid/unmigrated Version: rel:R25-11#f0c4993d Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81009@rel:R25-11#f0c4993d
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill

function ~S2RSatellite [SWS_SM_81005] Upstream: RS_SM_00402

virtual ~S2RSatellite () noexcept;

Destructor for S2RSatellite.

Header-Datei#include "ara/sm/s2r/S2RSatellite.h"
Scopeclass ara::sm::s2r::S2RSatellite
Exception-Sicherheitexception safe
Thread-Sicherheitnot thread-safe

Request a governed re-review of this record. The record is not changed immediately.

Record
AUTOSAR/AP/record/SWS_SM_81005
Status
valid/unmigrated
Version
AUTOSAR/AP/record/SWS_SM_81005@rel:R25-11#4b892348
Content hash
4b892348
Source
https://www.autosar.org/fileadmin/standards/R25-11/AP/AUTOSAR_AP_SWS_StateManagement.pdf#nameddest=SWS_SM_81005
Status: valid/unmigrated Version: rel:R25-11#4b892348 Versionshistorie & Revisions (1 transition)
Current State
valid/unmigrated
Reason
mechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record
Campaign
2026-08-13-status-backfill
Active Version
AUTOSAR/AP/record/SWS_SM_81005@rel:R25-11#4b892348
Point-in-Time History:
DateActorTransitionReason / RationaleCampaign
2026-08-13toolnone → valid/unmigratedmechanically backfilled by migriere_status_backfill.py -- no per-field curation history exists yet for this record2026-08-13-status-backfill