In this reference chapter you will find the API descriptions for the proxy and skeleton classes as well as some helpful additional classes.
Disclaimer: The API of MICROSAR QuickCom is built by public classes, their methods, free functions and types. Classes, their accessible methods, free functions and other types that are intended to be used by customers are annotated with the documentation tag \vpublic.
These items build the product public API.
Not part of the public API are items (classes, methods, free functions and types) marked with \vprivate, items that are defined in an “internal” namespace (e.g. ara::core::internal, amsr::socal::internal etc.).
These private items can be changed by Vector without further notice.
Changes of private items will not be documented in release notes. Customer software shall just use the public API of MICROSAR QuickCom. The private part shall not be used.
Skeleton APIs
Build a service provider.
Proxy APIs
Build a service consumer.
- ServiceInterface Proxy Class
- ProxyField Class Template
- ProxyEvent Class Template
- ProxyMethod Class Template
- ProxyFireAndForgetMethod Class Template
Helper APIs
Supporting features for your application.
Note: After the logging framework has been deinitialized no APIs or objects from the ara::log nor amsr::log namespace may be used. This also implies that no references to ara::log::Logger or any other objects may be held or used.