Skip to content

Commit

Permalink
ci: feat: Api updates for the discovery api changes in C SDK includin…
Browse files Browse the repository at this point in the history
…g ev… (#1374)

Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
  • Loading branch information
edgex-jenkins committed Sep 30, 2024
1 parent cd2c9a3 commit 830032a
Show file tree
Hide file tree
Showing 5 changed files with 483 additions and 330 deletions.
153 changes: 153 additions & 0 deletions 3.2/microservices/device/sdk/api/CDeviceSDK/CDeviceSDKAPI/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1214,6 +1214,11 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_discovery_delete">
devsdk_discovery_delete
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_describe">
devsdk_describe
</a>
Expand All @@ -1224,6 +1229,11 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_callbacks_set_discovery_delete">
devsdk_callbacks_set_discovery_delete
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_add_device_callback">
devsdk_add_device_callback
</a>
Expand Down Expand Up @@ -1356,6 +1366,16 @@
devsdk_free_devices
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_publish_discovery_event">
devsdk_publish_discovery_event
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_publish_system_event">
devsdk_publish_system_event
</a>
</li>
</ul>
</nav>
</li>
Expand Down Expand Up @@ -3159,6 +3179,11 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_discovery_delete">
devsdk_discovery_delete
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_describe">
devsdk_describe
</a>
Expand All @@ -3169,6 +3194,11 @@
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_callbacks_set_discovery_delete">
devsdk_callbacks_set_discovery_delete
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_add_device_callback">
devsdk_add_device_callback
</a>
Expand Down Expand Up @@ -3301,6 +3331,16 @@
devsdk_free_devices
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_publish_discovery_event">
devsdk_publish_discovery_event
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#devsdk_publish_system_event">
devsdk_publish_system_event
</a>
</li>
</ul>
</nav>
</li>
Expand Down Expand Up @@ -3891,6 +3931,35 @@ <h3 id="devsdk_discover">devsdk_discover</h3>
<td>void*</td>
<td>The context data passed in when the service was created</td>
</tr>
<tr>
<td>request_id</td>
<td>const char*</td>
<td>The discovery request ID</td>
</tr>
</tbody>
</table>
<h3 id="devsdk_discovery_delete">devsdk_discovery_delete</h3>
<p>This function is called when a delete request for discovery is made.</p>
<p>Implementations should perform logic for stopping a discovery request that is in progress. The implementation should return True on success or False for unsuccessful.</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>impl</td>
<td>void*</td>
<td>The context data passed in when the service was created</td>
</tr>
<tr>
<td>request_id</td>
<td>const char*</td>
<td>The discovery request ID</td>
</tr>
</tbody>
</table>
<h3 id="devsdk_describe">devsdk_describe</h3>
Expand Down Expand Up @@ -3960,6 +4029,29 @@ <h3 id="devsdk_callbacks_set_discovery">devsdk_callbacks_set_discovery</h3>
</tr>
</tbody>
</table>
<h3 id="devsdk_callbacks_set_discovery_delete">devsdk_callbacks_set_discovery_delete</h3>
<p>Call this to add your discovery delete function to the callbacks structure</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>cb</td>
<td>devsdk_callbacks*</td>
<td>structure to be modified</td>
</tr>
<tr>
<td>discover</td>
<td>devsdk_discovery_delete</td>
<td>device discovery delete function</td>
</tr>
</tbody>
</table>
<h3 id="devsdk_add_device_callback">devsdk_add_device_callback</h3>
<p>To be notified when a device is added to the system (and assigned to this device service), provide an implementation of this function</p>
<table>
Expand Down Expand Up @@ -4573,6 +4665,67 @@ <h3 id="devsdk_free_devices">devsdk_free_devices</h3>
</tr>
</tbody>
</table>
<h3 id="devsdk_publish_discovery_event">devsdk_publish_discovery_event</h3>
<p>Publish a system event for discovery. Events will be published to "edgex.system-event.(service-name).device.discovery".</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>svc</td>
<td>devsdk_service_t*</td>
<td>The device service</td>
</tr>
<tr>
<td>request_id</td>
<td>const char*</td>
<td>The discovery request ID</td>
</tr>
<tr>
<td>progress</td>
<td>const int8</td>
<td>Progress value (percent complete)</td>
</tr>
<tr>
<td>discovered_devices</td>
<td>uint64</td>
<td>The number of discovered devices</td>
</tr>
</tbody>
</table>
<h3 id="devsdk_publish_system_event">devsdk_publish_system_event</h3>
<p>Publish a generic system event. Events will be published to "edgex.system-event.(service-name).device.(action)".</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>svc</td>
<td>devsdk_service_t*</td>
<td>The device service</td>
</tr>
<tr>
<td>action</td>
<td>const char*</td>
<td>The action that triggered the event to be used in the topic name</td>
</tr>
<tr>
<td>details</td>
<td>iot_data_t*</td>
<td>A map of parameters to be published in the event details</td>
</tr>
</tbody>
</table>
</article>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion 3.2/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 830032a

Please sign in to comment.