InterExtensionCommunication

About the "InterExtensionCommunication" sample

The "InterExtensionCommunication" sample extension is a server extension that showcases communication between extensions. For this, it implements multiple function symbols using the "RequestListener" interface.

First steps:

• Working with server extensions
• Interacting with a server extension

Example requests

1. The "ListLocalRoutes" function symbol calls "ADS.ListRoutes" and only returns the local ADS routes.

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "InterExtensionCommunication.ListLocalRoutes",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }

   Response:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "InterExtensionCommunication.ListLocalRoutes",
               "readValue": [
                   {
                       "label": "local (127.0.0.1.1.1)",
                       "name": "local",
                       "value": "127.0.0.1.1.1"
                   },
                   {
                       "label": "local_remote (172.17.62.213.1.1)",
                       "name": "local_remote",
                       "value": "172.17.62.213.1.1"
                   }
               ]
           }
       ]
   }

2. The "CheckClientLicenseAndListLocalRoutes" function symbol calls "ADS.ListRoutes" and "ADS.CheckLicense" simultaneously and combines the results.

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "InterExtensionCommunication.CheckClientLicenseAndListLocalRoutes",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }

   Response:

   {
       "commands": [
           {
               "symbol": "InterExtensionCommunication.CheckClientLicenseAndListLocalRoutes",
               "readValue": {
                   "clientLicense": {
                       "count": 168,
                       "expireTimeUTC": "2021-01-01T00:00:00Z",
                       "result": 596
                   },
                   "localRoutes": [
                       {
                           "label": "local (127.0.0.1.1.1)",
                           "name": "local",
                           "value": "127.0.0.1.1.1"
                       },
                       {
                           "label": "local_remote (172.17.62.213.1.1)",
                           "name": "local_remote",
                           "value": "172.17.62.213.1.1"
                       }
                   ]
               }
           }
       ]
   }

3. The "DoubleAdsTimeout" function symbol reads from and writes to the ADS extension's configuration ("ADS.Config").

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "InterExtensionCommunication.DoubleAdsTimeout",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }

4. The "AddSymbolForAdsTimeout" function symbol creates a new mapped symbol "InterExtensionCommunication.AdsTimeout" that allows all members of the "__SystemUsers" group to read and write the ADS timeout in the ADS extension configuration ("ADS.Config::TIMEOUT").

   Request:

   {
       "requestType": "ReadWrite",
       "commands": [
           {
               "symbol": "InterExtensionCommunication.AddSymbolForAdsTimeout",
               "commandOptions": [ "SendErrorMessage" ]
           }
       ]
   }