api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Last revision Both sides next revision | ||
|
api [2018/01/12 17:10] Mats Wichmann |
api [2018/01/12 17:14] Mats Wichmann |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| ===== VISIBILITY ===== | ===== VISIBILITY ===== | ||
| - | In [[sources]] all supported APIs are defined in headers in directories named ''include'', while project-private ones are in directories named ''internal''. Not official (proposed) interfaces appear in headers in directories named ''experimental'' - use these with caution because not only are experimental APIs subject to no stability guarantees, but the segmentation of interfaces is not precise at the moment, some interfaces in those headers may not even be in the 'proposed' category but instead purley internal. | + | In [[sources]] all supported APIs are defined in headers in directories named ''include'', while project-private ones are in directories named ''internal''. |
| To check visibility of headers, you can rely on | To check visibility of headers, you can rely on | ||
| Line 15: | Line 15: | ||
| scons install | scons install | ||
| - | For convenience some [[examples]] are using "experimental" [[API]] (not in public headers). | + | For convenience some [[examples]] are using experimental APIs (not in public headers), indicated by headers in directories named ''experimental''. Use these with caution because not only are experimental APIs subject to no stability guarantees, but the segmentation of interfaces is not precise at the moment, some interfaces in those headers may not even be in the 'proposed' category but instead purley internal. |
| - | + | ||
| - | There is not guarantee those functions will be supported in future, so those internal headers are located in "[[experimental]]" subdirectories (like: utilities, logging...). | + | |
| Note to developers, It is desirable to have [[examples]] working with installed version of iotivity | Note to developers, It is desirable to have [[examples]] working with installed version of iotivity | ||
api.txt · Last modified: 2018/03/12 13:31 by Phil Coval
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution 3.0 Unported
