# SOME/IP Gateway Server Service - [API reference](https://docs.qualcomm.com/doc/80-41102-2/topic/_doxygen_rst_file__doxygen_sources_taf_someipSvr_interface_h.html#file-taf-someipsvr-interface-h) The SOME/IP Gateway Server Service supports SOME/IP protocol([http://some-ip.com/](http://some-ip.com/)) through vsomeip ([https://github.com/COVESA/vsomeip](https://github.com/COVESA/vsomeip)) library APIs. It provides TelAF APIs for application to serve as a SOME/IP server which can receive client requests, send responses, produce events and publish the events over SOME/IP-SD message and SOME/IP message in the vehicle network. ## IPC interfaces binding The functions of this API are provided by the **tafSomeipGWSvc** application service. The following example illustrates how to bind to the SOME/IP Gateway Server Service. bindings: { clientExe.clientComponent.taf_someipSvr -> tafSomeipGWSvc.taf_someipSvr } Copy to clipboard ## System configuration Before using any API of the service, the user needs to configure the system properly Since the SOME/IP Gateway Server Service is built upon vsomeip library, the configuration follows the same JSON format as vsomeip. The user can take the default vsomeip JSON file which locates in /legato/systems/current/appsWriteable/tafSomeipGWSvc/tafSomeipGWSvc.json as a template to make their own specific configuration. The default JSON file is as below: { "unicast" : "192.168.225.1", "device" : "bridge0", "logging" : { "level" : "error", "console" : "true", "file" : { "enable" : "false", "path" : "/tmp/vsomeip.log" }, "version" : { "enable" : "false", "interval" : "10" }, "dlt" : "false" }, "applications" : [ { "name" : "tafSomeipGWSvc", "id" : "0x0101" } ], "routing" : "tafSomeipGWSvc", "network" : "tafSomeipGWSvc", "service-discovery" : { "enable" : "true", "multicast" : "224.0.0.1", "port" : "30490", "protocol" : "udp", "initial_delay_min" : "10", "initial_delay_max" : "100", "repetitions_base_delay" : "200", "repetitions_max" : "3", "ttl" : "3", "cyclic_offer_delay" : "2000", "request_response_delay" : "1500" } } Copy to clipboard Mandatorily, the **unicast** and **device** must be set with the correct IP address and network interface in the system for SOME/IP communications. The **id** in applications section shall be set with a unique client ID within the given network. Optionally, the SOME/IP-SD parameters (like **multicast**) in service-discovery section can be changed if needed. Restart the tafSomeipGWSvc service or reboot the device to make the new configuration take effect after any modifications. ## Multiple networks/VLANs configuration The default configuration file is only for single network/VLAN which is also the default network. If the user wants to support multiple networks/VLANs in the GW service, they have to create additional configuration files. These configuration files can be someipGWSvc\_1.json to tafSomeipGWSvc\_7.json, which means a maximum of 8 networks/VLANs can be supported. For example, the user can create below configuration file to support the second network/VLAN in the GW service: { "unicast" : "192.168.226.1", "device" : "eth1", "logging" : { "level" : "error", "console" : "true", "file" : { "enable" : "false", "path" : "/tmp/vsomeip.log" }, "version" : { "enable" : "false", "interval" : "10" }, "dlt" : "false" }, "applications" : [ { "name" : "tafSomeipGWSvc_1", "id" : "0x0102" } ], "routing" : "tafSomeipGWSvc_1", "network" : "tafSomeipGWSvc_1", "service-discovery" : { "enable" : "true", "multicast" : "225.0.0.1", "port" : "30490", "protocol" : "udp", "initial_delay_min" : "10", "initial_delay_max" : "100", "repetitions_base_delay" : "200", "repetitions_max" : "3", "ttl" : "3", "cyclic_offer_delay" : "2000", "request_response_delay" : "1500" } } Copy to clipboard In this case, a second configuration file tafSomeipGWSvc\_1.json is created for network interface “eth1” with its own network address and multicast address. **NOTE:** The value of **name**, **routing**, and **network** in configuration file must match the file name, which is tafSomeipGWSvc\_1 in this case. ## CommonAPI server configuration The TelAF SOME/IP GW service can be used as the consolidated vsomeip routing manager for both TelAF applications and commonAPI applications if they are in the same network/VLAN. Here is an example to declare a commonAPI server application and add its services in someipGWSvc\_1.json: { "unicast" : "192.168.226.1", "device" : "eth1", "logging" : { "level" : "error", "console" : "true", "file" : { "enable" : "false", "path" : "/tmp/vsomeip.log" }, "version" : { "enable" : "false", "interval" : "10" }, "dlt" : "false" }, "applications" : [ { "name" : "tafSomeipGWSvc_1", "id" : "0x0102" }, { "name" : "commonapiServerApp", "id" : "0x0112" } ], "services" : [ { "service" : "0xED80", "instance" : "0x0001", "unreliable" : "31000" }, { "service" : "0xED81", "instance" : "0x0001", "unreliable" : "31000" } ], "routing" : "tafSomeipGWSvc_1", "network" : "tafSomeipGWSvc_1", "service-discovery" : { "enable" : "true", "multicast" : "225.0.0.1", "port" : "30490", "protocol" : "udp", "initial_delay_min" : "10", "initial_delay_max" : "100", "repetitions_base_delay" : "200", "repetitions_max" : "3", "ttl" : "3", "cyclic_offer_delay" : "2000", "request_response_delay" : "1500" } } Copy to clipboard In this case, the vsomeip application(ID=0x0112) “commonapiServerApp” is a commonAPI server application that offers two services(0xED80/0x0001 and 0xED81/0x0001) on UDP port 31000 of unicast address 192.168.226.1. **NOTE:** Once a commonAPI server service is declared in the JSON file, it means that service is offered by the commonAPI application. Do not call any taf\_someipSvr() APIs to offer that service again in a TelAF application, otherwise it will cause unexpected result. ## Reserved service IDs and application IDs The following vsomeip service IDs are reserved: \* +——————–+————-+——-+——————————————–+\* | Service ID range | Port range | Total | Usage [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id1)\* +====================+=============+=======+============================================+\* | 0xED00-0xED7F | 40000-40127 | 128 | TelAF RPC services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id3)\* +——————–+————-+——-+——————————————–+\* | 0xED80-0xEDFF | 41000-41127 | 128 | TelAF IVSS services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id5)\* +——————–+————-+——-+——————————————–+\* | 0xEE00-0xEE3F | 42000-42063 | 64 | IVSS Location/Sensor services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id7)\* +——————–+————-+——-+——————————————–+\* The following vsomeip application instance IDs are reserved: \* +————————+——-+———————————————–+\* | App instance ID range | Total | Usage [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id9)\* +========================+=======+===============================================+\* | 0x0101-0x0108 | 8 | TelAF SOME/IP GW service [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id11)\* +————————+——-+———————————————–+\* | 0x0201-0x0208 | 8 | TelAF IVSS services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id13)\* +————————+——-+———————————————–+\* | 0x0301-0x0308 | 8 | IVSS Location services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id15)\* +————————+——-+———————————————–+\* | 0x030A-0x030D | 4 | IVSS Sensor services [|](https://docs.qualcomm.com/doc/80-41102-2/topic/page_c_tafSomeipSvr.html#id17)\* +————————+——-+———————————————–+\* **NOTE:** In additional JSON files for multiple networks/VLANs, the application name must be tafSomeipGWSvc\_1 to tafSomeipGWSvc\_7, and the values of “name”, “routing”, and “network” must match the file name. ## Server-service APIs Before setting up a server-service-instance, application shall first get the service reference by calling [taf\_someipSvr\_GetService()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1accb9bb1a906e603c1fd1b48bf1f145b2.html#Documentationa00716_1accb9bb1a906e603c1fd1b48bf1f145b2) or [taf\_someipSvr\_GetServiceEx()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a22b20d6d7663e98c1c5fc255d401002f.html#Documentationa00716_1a22b20d6d7663e98c1c5fc255d401002f) and use the reference returned for subsequent operations. **NOTE:** One SOME/IP server-service-instance can be only represented by one application. The following example illustrates how to set up a SOME/IP server-service-instance and offer the service on default network interface. const uint16_t serviceId = 0x1234; // Service ID const uint16_t instanceId = 0x5678; // Service instance const uint8_t majorVer = 0x21; // Major version of the service const uint32_t minorVer = 0x87654321; // Minor version of the service const uint16_t tcpPort = 40000; // TCP port of the service const uint16_t udpPort = 40001; // UDP port of the service taf_someipSvr_ServiceRef_t serviceRef; // Service reference // Get the service reference on the default network interface. serviceRef = taf_someipSvr_GetService(serviceId, instanceId); LE_ASSERT(serviceRef != NULL); // Set the service version. LE_ASSERT(LE_OK == taf_someipSvr_SetServiceVersion(serviceRef, majorVer, minorVer)); // Set the service ports. LE_ASSERT(LE_OK == taf_someipSvr_SetServicePort(serviceRef, udpPort, tcpPort, true)); // Offer the service with our setting version and port. LE_ASSERT(LE_OK == taf_someipSvr_OfferService(serviceRef)); Copy to clipboard Application can call [taf\_someipSvr\_StopOfferService()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a2b036b52e4baa4c4f3297cd3bfa6f6ab.html#Documentationa00716_1a2b036b52e4baa4c4f3297cd3bfa6f6ab) to stop the service after the service is offered successfully. ## Message APIs After the service reference is got, the application can call [taf\_someipSvr\_AddRxMsgHandler()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a4c1bda902f1dcaf34e9dfc4724e29708.html#Documentationa00716_1a4c1bda902f1dcaf34e9dfc4724e29708) to register a message handler for that service. Once a SOME/IP request message for the service is received, the message handler will be called and a message reference is passed as an input parameter to the application. The application can use this reference to retrieve the message header and payload, and then call [taf\_someipSvr\_SendResponse()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1aea266e2eb656e0146b76e8af9a6335a8.html#Documentationa00716_1aea266e2eb656e0146b76e8af9a6335a8) with the reference to send back a response. Finally call [taf\_someipSvr\_ReleaseRxMsg()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1aab742877d5ecdbb50bc737bdfe37df5b.html#Documentationa00716_1aab742877d5ecdbb50bc737bdfe37df5b) to release the message. The following example illustrates how to register a message handler, get the message data and send back a response in a handler. // Rx message handler function. void RxMessageHandler ( taf_someipSvr_RxMsgRef_t msgRef, void* contextPtr ) { // Get the service ID and instance ID. uint16_t serviceId; uint16_t instanceId; LE_ASSERT(LE_OK == taf_someipSvr_GetServiceId(msgRef, &serviceId, &instanceId)); // Get the method ID client ID and message type. uint16_t methodId; uint16_t clientId; uint8_t msgType; LE_ASSERT(LE_OK == taf_someipSvr_GetMethodId(msgRef, &methodId)); LE_ASSERT(LE_OK == taf_someipSvr_GetClientId(msgRef, &clientId)); LE_ASSERT(LE_OK == taf_someipSvr_GetMsgType(msgRef, &msgType)); // Get the payload. uint8_t payloadData[128]; size_t payloadSize = sizeof(payloadData); char payloadString[2*sizeof(payloadData) + 1]; LE_ASSERT(LE_OK == taf_someipSvr_GetPayloadSize(msgRef, &payloadSize)); // Print out the message information. LE_INFO("Rx message(servId/instId/methId/cliId/msgType/len=0x%x/0x%x/0x%x/0x%x/0x%x/0x%x)", serviceId, instanceId, methodId, clientId, msgType, payloadSize); // Get the payload data if the payload is not empty. if (payloadSize != 0) { // Read the payload data into our buffer. payloadSize = sizeof(payloadData); LE_ASSERT(LE_OK == taf_someipSvr_GetPayloadData(msgRef, payloadData, &payloadSize)); // Print out the payload data with hex string format. le_hex_BinaryToString(payloadData, payloadSize, payloadString, sizeof(payloadString)); LE_INFO("MESSAGE PAYLOAD [%s]", payloadString); } // Send back the response with the same payload data. The Rx message will be automatically // released if sending the response succeeds. if (LE_OK != taf_someipSvr_SendResponse(msgRef, false, 0, payloadData, payloadSize)); { // Only release the Rx message if sending the response fails. LE_ASSERT(LE_OK == taf_someipSvr_ReleaseRxMsg(msgRef)); } } // Register the message handler. taf_someipSvr_RxMsgHandlerRef_t RxMsgHandlerRef = taf_someipSvr_AddRxMsgHandler(ServiceRef, RxMessageHandler, NULL); LE_ASSERT(RxMsgHandlerRef != NULL); Copy to clipboard **NOTE:** One SOME/IP server-service-instance can register only one message handler. ## Event APIs After a service is offered, application can call [taf\_someipSvr\_EnableEvent()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a8b4f61ca6151fd38d11ee84276910664.html#Documentationa00716_1a8b4f61ca6151fd38d11ee84276910664) to set up an event for the service and then call [taf\_someipSvr\_OfferEvent()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1aba30f91b581107fcdfe7ab6c0e69d349.html#Documentationa00716_1aba30f91b581107fcdfe7ab6c0e69d349) to offer the event within the vehicle network, later call [taf\_someipSvr\_Notify()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a54b8f0fe72c606756c588d98c43c9fa1.html#Documentationa00716_1a54b8f0fe72c606756c588d98c43c9fa1) to publish the event with given payload data. The following example illustrates how to set up an event and publish the event. const uint16_t eventId = 0x8001; // Event ID, valid range: 0x8001 to 0xFFFE const uint16_t eventGroupId = 0x1; // Event Group ID, valid range: 0x0001 to 0xFFFE // Enable the event by adding it to an event group. LE_ASSERT(LE_OK == taf_someipSvr_EnableEvent(serviceRef, eventId, eventGroupId)); // Offer the event within the vehicle network. LE_ASSERT(LE_OK == taf_someipSvr_OfferEvent(serviceRef, eventId)); // Publish the event with given payload. uint8_t payloadData[5] = { 0x1, 0x2, 0x3, 0x4, 0x5 }; LE_ASSERT(LE_OK == taf_someipSvr_Notify(serviceRef, eventId, payloadData, sizeof(payloadData))); Copy to clipboard **NOTE:** An event must be enabled before offering, and the [taf\_someipSvr\_Notify()](https://docs.qualcomm.com/doc/80-41102-2/topic/function_a00716_1a54b8f0fe72c606756c588d98c43c9fa1.html#Documentationa00716_1a54b8f0fe72c606756c588d98c43c9fa1) is available only after the event is offered. Last Published: Jun 09, 2026 [Previous Topic SOME/IP Gateway Client Service](https://docs.qualcomm.com/bundle/publicresource/80-41102-2/topics/page_c_tafSomeipClnt.md) [Next Topic Thermal Management Service](https://docs.qualcomm.com/bundle/publicresource/80-41102-2/topics/page_c_taftherm.md)