clase <SI-Namespace>::proxy::fields::<Field>

usar

El método Get sirve en el ámbito del proxy <SI-Namespace>::proxy::fields::<Field> para la recuperación asíncrona del valor actual del campo ([SWS_CM_00112]; véase también AUTOSAR_AP_EXP_ARAComAPI §6 «FieldGet»). La función se proporciona a través de la cabecera del proxy <SiNamespaceDerivedDirectoryPath>/<SiShortname>_proxy.h y solo existe si para el campo está modelado Field.hasGetter == TRUE ([SWS_CM_00112]). No toma parámetros y devuelve un ara::core::Future<FieldType> que, tras una transmisión exitosa, contiene el valor actual ([SWS_CM_00112]).

Tratamiento de errores y condiciones límite

La interfaz está definida como noexcept y segura frente a excepciones ([SWS_CM_00112]). Si la operación falla, el ara::core::Future devuelto contiene un código de error con semántica de reversión ([SWS_CM_00112]):

• ComErrc::kCommunicationFailure: La vinculación de red notifica un error de comunicación subsanable o el fallo de una comunicación protegida ([SWS_CM_00112]).
• ComErrc::kMinimumSendIntervalViolationError: Se realizó una solicitud de envío con mayor rapidez de lo permitido por el intervalo de envío mínimo configurado para el elemento (minimumSendInterval) ([SWS_CM_00112]).
• InsufficientPermissionsViolation: La ejecución es rechazada por el Grant Enforcement ([SWS_CM_00112]).

No existen errores de aplicación (Application Errors) para el getter ([SWS_CM_00113]).

Interacción

En el lado del skeleton, el procesamiento de la solicitud del getter presupone un callback registrado a través de RegisterGetHandler ([SWS_CM_00114]). Cada invocación de Get() ejecuta una comprobación de extremo a extremo (E2E); el estado resultante de ella puede consultarse de forma síncrona en el lado del proxy a través de GetE2EStateMachineStateGetter ([SWS_CM_00145]).

Uso y contexto de llamada

La función Set se proporciona en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> y está disponible exclusivamente si para el campo está configurado Field.hasSetter == TRUE [SWS_CM_00113]. Antes de su utilización, la instancia de servicio debe haber sido ofrecida en el lado del servidor (OfferService()) y encontrada y conectada en el lado del cliente ARAComAPI §4.2 «Means of Communication». La invocación se realiza de forma asíncrona: transfiere el nuevo valor del campo a través del parámetro value y devuelve un ara::core::Future<FieldType> [SWS_CM_00113]. El método está especificado como noexcept y se considera seguro frente a excepciones [SWS_CM_00113].

Manejo de errores

Si la transmisión falla, el error correspondiente se proporciona a través del ara::core::Future devuelto [SWS_CM_00113]:

• ComErrc::kCommunicationFailure: Notifica un error de comunicación subsanable o una anomalía en la transmisión segura; en caso de un tiempo de espera agotado, puede existir un estado indeterminado en el lado del servidor sin semántica de reversión [SWS_CM_00113].
• ComErrc::kMinimumSendIntervalViolationError: Se produce cuando se emitió una solicitud de envío más rápido que el intervalo de envío mínimo configurado (minimumSendInterval) (también sin semántica de reversión) [SWS_CM_00113].
• La falta de derechos de acceso da lugar a una denegación por parte de Grant Enforcement (InsufficientPermissionsViolation) [SWS_CM_00113].
• Los errores de aplicación no se transportan a través de excepciones, sino devolviendo, en caso de éxito del future, un valor que difiere del parámetro de solicitud [SWS_CM_00113].

Interacción y concurrencia

En el lado del servidor, la invocación se corresponde con un callback en la instancia del skeleton que debe registrarse previamente mediante RegisterSetHandler [SWS_CM_00116] ARAComAPI §4.2 «Means of Communication». Para supervisar la seguridad de transmisión E2E en el lado del cliente, se puede consultar el estado de la máquina de estados de E2E de la última invocación de Set() a través de GetE2EStateMachineStateSetter() [SWS_CM_00146].

Uso y contexto de llamada

La función SetReceiveHandler se proporciona en el lado del proxy en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> a través del archivo de encabezado <SiNamespaceDerivedDirectoryPath>/<SiShortname>_proxy.h ([SWS_CM_11605]). Registra en el lado del cliente un callback para notificaciones en caso de cambios de valor de un campo ([SWS_CM_11605]). Este mecanismo sigue el procedimiento de notificación de eventos, mediante el cual Communication Management informa al cliente en caso de actualizaciones (EXP_ARAComAPI §4.2 «Means of Communication»).

Como parámetro se pasa un ara::com::FieldReceiveHandler, que representa una función sin parámetros ([SWS_CM_11605]). La función no devuelve ningún valor de retorno (void) y está especificada como segura frente a excepciones (noexcept) ([SWS_CM_11605]).

Tratamiento de errores y concurrencia

Si el objeto invocable (callable) transferido no existe o es nulo, la función notifica la vulneración InvalidHandlerViolation ([SWS_CM_11605]). Si la ejecución del manejador debe realizarse en un contexto de ejecución definido, se encuentra disponible la variante de plantilla con ExecutorT ([SWS_CM_11611]).

Interacción

El comportamiento se corresponde con los registros de manejadores para eventos ([SWS_CM_00181]) y triggers ([SWS_CM_00250]). Siguiendo el patrón de interfaz de la clase proxy, es de suponer que la cancelación del registro se realice a través de UnsetReceiveHandler() (EXP_ARAComAPI §5.3.1 «Proxy Class API’s»). Pregunta Q-74cd83b99aadec16 (abierta)

Uso y contexto de llamada

La función de plantilla SetReceiveHandler forma parte de la clase proxy class <SI-Namespace>::proxy::fields::<Field> ([SWS_CM_11611]; encabezado #include "<SiNamespaceDerivedDirectoryPath>/<SiShortname>_proxy.h"). Sirve para registrar, en el lado del cliente, un manejador de recepción para notificaciones en caso de cambios de valor de un campo (AUTOSAR_AP_EXP_ARAComAPI §4.2 «Means of Communication», [SWS_CM_11605]). A través de los parámetros se transfieren un objeto invocable handler de tipo ara::com::FieldReceiveHandler, así como un contexto de ejecución executor como referencia universal ExecutorT&& ([SWS_CM_11611]). La función no posee valor de retorno (void).

Tratamiento de errores y seguridad frente a excepciones

El método está declarado como noexcept y especificado como seguro frente a excepciones (exception safe) ([SWS_CM_11611]). Si el callable handler transferido no existe o es nulo, se produce una InvalidHandlerViolation ([SWS_CM_11611]). Por lo tanto, los invocadores deben asegurarse de proporcionar un objeto de función o función válido antes de la llamada.

Concurrencia e interacción

A diferencia del registro estándar sin executor ([SWS_CM_11605]), al llegar una notificación de campo el callback se procesa en el contexto de ejecución proporcionado por executor ([SWS_CM_11611]). Interpretación: Es de suponer que esto provoque un desacoplamiento, de modo que el procesamiento de datos específico de la aplicación no se realice en los contextos de ejecución de hilos internos del middleware. Pregunta Q-cbe1af19bea15a88 (abierta) El método pertenece a las API de la clase proxy (AUTOSAR_AP_EXP_ARAComAPI §5.3.1 «Proxy Class API’s») y sigue el mismo patrón que las variantes con executor para eventos ([SWS_CM_11356] basado en [SWS_CM_00181]), así como para triggers ([SWS_CM_00352] basado en [SWS_CM_00250]).

La función SetSubscriptionStateChangeHandler registra en un campo de proxy (ámbito <SI-Namespace>::proxy::fields::<Field>) una devolución de llamada personalizada a la que llama Communication Management en cuanto cambia el estado de suscripción (ara::com::SubscriptionState) del campo ([SWS_CM_11607], [SWS_CM_00333]). La llamada se efectúa de forma síncrona y no devuelve ningún valor de retorno ([SWS_CM_11607]). Forma parte de las interfaces proxy centrales para la gestión de suscripciones a eventos y campos (AUTOSAR_AP_EXP_ARAComAPI §5.3.1 «Proxy Class API’s»).

En lo que respecta al tratamiento de errores, la función de registro está especificada como exception safe y declarada con noexcept ([SWS_CM_11607]). En caso de que el objeto invocable transferido handler no exista o sea null, se produce una infracción de la especificación en forma de una InvalidHandlerViolation ([SWS_CM_11607]).

En interacción con el establecimiento de la conexión, se debe tener en cuenta que Subscribe() debe considerarse en principio como una operación asíncrona ([SWS_CM_12006]). Por lo tanto, las aplicaciones no deben asumir una suscripción exitosa, incluso tras un retorno sin errores de Subscribe(), hasta que el manejador registrado haya señalado el estado kSubscribed ([SWS_CM_12006]). Además, Communication Management invoca al manejador con kSubscriptionPending si la vinculación real no puede completarse de inmediato o si la instancia del servidor falla, por ejemplo, a consecuencia de un reinicio o un error de red ([SWS_CM_00313]). Si se desea que el manejador se ejecute en un contexto de ejecución específico, para ello está disponible la variante de plantilla sobrecargada con un ExecutorT ([SWS_CM_11608]).

La función de plantilla SetSubscriptionStateChangeHandler en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> sirve para registrar una función de callback destinada a supervisar cambios de estado de la suscripción de un campo ([SWS_CM_11608]). Amplía el comportamiento básico de [SWS_CM_11607] en el sentido de que el manejador registrado se ejecuta en un contexto de ejecución transferido explícitamente (executor) ([SWS_CM_11608]).

El método recibe dos parámetros ([SWS_CM_11608]):

• handler: El callback que se debe invocar, de tipo ara::com::SubscriptionStateChangeHandler ([SWS_CM_11354]), el cual se dispara en cuanto cambia el ara::com::SubscriptionState ([SWS_CM_00333]).
• executor: Una referencia de reenvío de tipo ExecutorT&& ([SWS_CM_11360]) que proporciona el contexto para la ejecución del manejador ([SWS_CM_11608]).

La función no devuelve ningún valor de retorno (void) y está declarada como noexcept ([SWS_CM_11608]). Está especificada como exception safe ([SWS_CM_11608]). Como vulneración se define InvalidHandlerViolation si el callable transferido no existe o es null ([SWS_CM_11608]).

Interpretación: Mediante la transferencia del executor, es de suponer que la ejecución del manejador se desplace del contexto interno de la gestión de comunicación al contexto de hilo o de tareas de la aplicación. Pregunta Q-647f618545799c4e (abierta) En la interacción de las API de proxy, la llamada se alinea junto a métodos como Subscribe(), Unsubscribe() y UnsetSubscriptionStateChangeHandler() (AUTOSAR_AP_EXP_ARAComAPI §5.3.1 «Proxy Class API’s»). Existen variantes sobrecargadas análogas con contexto de ejecución para eventos de proxy ([SWS_CM_11354]), así como para triggers de proxy ([SWS_CM_01106]).

Uso y contexto de llamada

La función miembro SetTransportFaultConditionHandler sirve para registrar un manejador de errores para el notificador de un campo de proxy en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> [SWS_CM_00109]. Como parámetro se pasa un objeto invocable (callable) del tipo ara::com::e2e::TransportFaultConditionHandler. La función no devuelve ningún valor y vincula la retrollamada a los notificadores de instancias de servicio individuales para recibir errores de transmisión del backend de comunicación AUTOSAR_AP_SWS_CommunicationManagement §7.4 «End-to-end communication protection» p. 235.

Tratamiento de errores y seguridad frente a excepciones

El método está declarado como noexcept y especificado como seguro ante excepciones (exception safe) [SWS_CM_00109]. Si el invocable pasado no es válido o es null, se produce una infracción de la precondición en forma de InvalidHandlerViolation [SWS_CM_00109]. Interpretación: dado que la función no debe lanzar excepciones, es de esperar que en AUTOSAR Adaptive dicha infracción provoque habitualmente la terminación inmediata del programa. Pregunta Q-74df6934d4ae3c93 (abierta)

Concurrencia e interacción

Mientras que esta forma básica registra el manejador directamente, con [SWS_CM_00110] existe una variante de plantilla sobrecargada que acepta adicionalmente un ejecutor (ExecutorT&& executor) para definir el contexto de ejecución asíncrono. La función se integra en el tratamiento de errores extremo a extremo: mientras que los notificadores ([SWS_CM_00109], [SWS_CM_00110]), eventos ([SWS_CM_00099]) y disparadores ([SWS_CM_00106]) notifican errores de transmisión de forma asíncrona a través de tales manejadores, los errores de transporte en solicitudes de métodos, así como de captadores y definidores, se devuelven en su lugar a través de ComErrc::kCommunicationFailure en el ara::core::Future resultante [SWS_CM_00090].

usar

La función miembro de plantilla SetTransportFaultConditionHandler sirve, en el ámbito de una clase de campo de proxy (<SI-Namespace>::proxy::fields::<Field>), para registrar un manejador para el notificador del campo correspondiente [SWS_CM_00110]. Recibe dos parámetros de entrada:

• handler: el invocable a registrar de tipo ara::com::e2e::TransportFaultConditionHandler [SWS_CM_00110].
• executor: una referencia rvalue a un objeto ejecutor (ExecutorT&&), en cuyo contexto de ejecución se inician los cálculos iniciados de forma asíncrona que pudieran existir [SWS_CM_00110].

La función no devuelve ningún valor (void) y está declarada como noexcept [SWS_CM_00110].

Tratamiento de errores y seguridad de ejecución

La interfaz está especificada como segura frente a excepciones (exception safe) [SWS_CM_00110]. Si se pasa como handler un invocable no existente o de valor nulo, esto da lugar a una InvalidHandlerViolation [SWS_CM_00110]. Mediante este manejador se notifican condiciones específicas de error de transporte, mientras que los métodos y los getters y setters de campos señalizan eventuales errores de transporte mediante ComErrc::kCommunicationFailure en sus respectivos futuros de retorno [SWS_CM_00090].

Concurrencia e interacción

El método constituye la sobrecarga de contexto de ejecución para la función base con menos parámetros [SWS_CM_00109]. Mediante el objeto ejecutor proporcionado, la implementación desacopla la ejecución del manejador del contexto de recepción interno de la gestión de comunicación [SWS_CM_00110]. Se dispone de sobrecargas similares para eventos de proxy [SWS_CM_00100], activadores de proxy [SWS_CM_00107], así como para métodos de Skeleton [SWS_CM_00094] y campos de Skeleton [SWS_CM_00097]. Interpretación: es razonable que la llamada se realice antes de la llegada de avisos del notificador o de la suscripción al notificador, con el fin de garantizar una supervisión de errores sin interrupciones. Pregunta Q-bc5c62dd39c09029 (abierta)

El método Subscribe sirve para suscribir notificaciones de un Field de una instancia de proxy de servicio en el ámbito proxy::fields::<Field> ([SWS_CM_11601]). Mediante el parámetro maxSampleCount, la aplicación define la cantidad máxima de muestras de datos que desea mantener simultáneamente y configura así la caché de recepción local ([SWS_CM_11601], EXP ARAComAPI §5.3 «Proxy Class API’s»). La llamada es asíncrona: el ara::core::Result<void> devuelto únicamente señaliza la aceptación de la suscripción por parte de Communication Management (EXP ARAComAPI §5.3.5.2 «Monitoring Event Subscription»).

Respecto al comportamiento de estado y al tratamiento de errores se aplican las siguientes reglas:

• Idempotencia: Si el Field ya se encuentra en el estado kSubscribed o kSubscriptionPending y el maxSampleCount transferido coincide con el valor de la suscripción actual, el método retorna sin efecto ([SWS_CM_11601]).
• Códigos de error: Si no es posible suministrar la caché requerida, la operación falla con el error ComErrc::kMaxSampleCountNotRealizable ([SWS_CM_11601], [SWS_CM_10432]).
• Comprobación de autorización: Si faltan los derechos requeridos, Grant Enforcement rechaza la llamada con una InsufficientPermissionsViolation ([SWS_CM_11601]).

El método está declarado como noexcept y especificado como Exception-safe ([SWS_CM_11601]). Semánticamente sigue el comportamiento de la suscripción a eventos ([SWS_CM_00141]); la caché configurada forma la base para la posterior recepción de muestras mediante métodos como GetNewSamples ([SWS_CM_00701]).

La función UnsetReceiveHandler() sirve, en el nivel de proxy, para desregistrar un manejador de recepción registrado previamente para notificaciones de campo ([SWS_CM_11606]). Pertenece a las API de clases proxy de ara::com (AUTOSAR_AP_EXP_ARAComAPI §5.3.1 «Proxy Class API’s») y se ubica en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> ([SWS_CM_11606]).

En cuanto al contexto de llamada y a la semántica, el método no acepta parámetros y no proporciona ningún valor de retorno ([SWS_CM_11606]). Mediante la llamada, una aplicación puede cambiar en cualquier momento de un modelo de notificación controlado por eventos a un funcionamiento de sondeo basado en consultas retirando la devolución de llamada específica del usuario (AUTOSAR_AP_EXP_ARAComAPI §5.3.2 «RadarService Proxy Class Example»).

Para el tratamiento de errores, la función está especificada como noexcept y exception safe ([SWS_CM_11606]); según la especificación, no existen códigos de error específicos. La llamada se realiza de forma síncrona; tras la retirada satisfactoria del manejador, Communication Management ya no desencadena más llamadas de devolución de llamada al llegar nuevos datos (interpretación: es probable que las ejecuciones en curso o ya programadas se finalicen o se procesen de forma serializada antes de la retirada, ya que las llamadas de devolución de llamada por parte de Communication Management deben realizarse de forma serializada; cf. AUTOSAR_AP_EXP_ARAComAPI §5.3.2 «RadarService Proxy Class Example»). Pregunta Q-fbc65e80b8d8be38 (abierta)

En la interacción, el método se corresponde con la desactivación de disparadores en eventos de servicio ([SWS_CM_00183]; AUTOSAR_AP_EXP_ARAComAPI §10) y disparadores ([SWS_CM_11614]). En el enlace DDS, el comportamiento se representa a través del mapeo de UnsetReceiveHandler() al DataReader correspondiente ([SWS_CM_11141]).

usar

El método UnsetSubscriptionStateChangeHandler sirve, en el marco de AUTOSAR Adaptive Platform, para eliminar un callback registrado previamente para cambios del estado de suscripción (ara::com::SubscriptionState) de un campo [SWS_CM_11609]. Se invoca de forma síncrona sobre instancias de campos de un proxy de servicio en el espacio de nombres <SI-Namespace>::proxy::fields::<Field> y requiere la inclusión de la cabecera generada #include "<SiNamespaceDerivedDirectoryPath>/<SiShortname>_proxy.h" AUTOSAR_AP_SWS_CommunicationManagement §8.3.3.2.4.5 «UnsetSubscriptionStateChangeHandler». La llamada no acepta parámetros y no devuelve ningún valor.

Tratamiento de errores y concurrencia

La interfaz está declarada como noexcept y, según la especificación, cumple con la propiedad exception safe [SWS_CM_11609]. Queda descartada, por tanto, la aparición de errores o excepciones. Dado que la baja de registro surte efecto de forma inmediata, cabe asumir (interpretación) que tras la finalización del método no se transferirán nuevas notificaciones al antiguo manejador. Pregunta Q-30238329b76b64f4 (abierta)

Interacción

La función pertenece a las API básicas de clases proxy para la gestión de suscripciones en ara::com AUTOSAR_AP_EXP_ARAComAPI §5.3.1 «Proxy Class API’s». Existen métodos similares para desactivar manejadores de cambios de estado para eventos de proxy [SWS_CM_00334] y disparadores [SWS_CM_01108], así como de forma refleja en el lado del skeleton para eventos [SWS_CM_12010] y disparadores [SWS_CM_01112].

usar

La función UnsetTransportFaultConditionHandler sirve para dar de baja nuevamente un ara::com::e2e::TransportFaultConditionHandler registrado previamente para el notificador de un campo de proxy determinado [SWS_CM_00126]. Está definida dentro del ámbito <SI-Namespace>::proxy::fields::<Field> y se incluye a través del archivo de cabecera <SiNamespaceDerivedDirectoryPath>/<SiShortname>_proxy.h AUTOSAR_AP_SWS_CommunicationManagement §8.3.3.2.1.4 «UnsetTransportFaultConditionHandler». La invocación se realiza sin parámetros y no devuelve ningún valor (void).

Manejo de errores

El método está declarado como noexcept y cuenta con la garantía de excepción exception safe [SWS_CM_00126]. No se devuelven códigos de error ni se lanzan excepciones. Si no se había registrado ningún manejador previamente, es probable que una invocación repetida no tenga efecto. Pregunta Q-85da9a7b00678748 (abierta)

Concurrencia y restricciones

La especificación no define requisitos específicos de concurrencia o seguridad entre hilos. Dado que la interfaz funciona de manera síncrona y no utiliza tipos asíncronos, es de esperar que la revocación del manejador de errores tenga efecto síncrono e inmediato. Pregunta Q-ed4cc712bb55aee5 (abierta) Quienes realicen la invocación deben coordinarla en el ciclo de vida de la aplicación de modo que los mensajes de notificador de instancias de servicio individuales no se procesen de forma descontrolada sin un manejador AUTOSAR_AP_SWS_CommunicationManagement §7.4.1 «End-to-end communication protection for SOMEIP».

Interacción

La baja de registro sigue un patrón de nomenclatura y funcionalidad coherente en AUTOSAR Adaptive:

• En el nivel de proxy, están disponibles funciones equivalentes para eventos ([SWS_CM_00105]), así como para disparadores ([SWS_CM_00108]).
• En el nivel de skeleton, existen homólogos correspondientes para getters y setters de campo ([SWS_CM_00098]), así como de forma global para todos los métodos de la interfaz skeleton ([SWS_CM_00095]).