| Note | ||
|---|---|---|
| ||
This section documents the details of the O-RAN App SDK which is primarily covering the implementation for near-RT RIC xApps. information about how the O-RAN App SDK will evolve to cover other O-RAN apps can be found here. |
Description
The C++ framework allows the programmer to create an xApp object instance, and to use that instance as the logic base. The xApp object provides a message level interface to the RIC Message Router (RMR), including the ability to register callback functions which the instance will drive as messages are received; much in the same way that an X-windows application is driven by the window manager for all activity. The xApp may also choose to use its own send/receive loop, and thus is not required to use the callback driver mechanism provided by the framework.
Bronze Release Version
Bronze Release development (master branch) version tag 4.0.5 (6 May 2020) -- Code is currently frozen; only bug fixes and documentation updates are being applied.
Release A frozen: 1.11.1 (Amber branch) 6 November 2019
Trial branch (r2-temp): 1.10.2 Fall 2019
Gerrit Repo
xappframework is a simple framework for rapid development of RIC xapps, and supports various services essential for RIC xapps such as RESTful APIs, RMR (RIC Message Routing), database backend services and watching and populating config-map changes in K8S environment. Currently there are three language specific frameworks: Python, Go, and C++. Features supported vary by each framework; please refer to the specific documentation for details.
Bronze Release Version
The following is the version and publication date for each of the frameworks:
| Language | Last Updated | Version |
|---|---|---|
| Python | 8 May 2020 | 1.1.1 |
| Go | 28 April 2020 | 0.4.9 |
| C++ | 28 April 2020 | 1.0.0 |
Gerrit Repo
The following are links to the code repository for each framework:
| Language | Repository Link |
|---|---|
| Python | https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py |
| Go | https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt |
...
Project WIKI Page
...
Discussions regarding ongoing development can be found on Wiki pages using the following anchor links:
| Language | Link |
|---|---|
| Python | xApp Framework for Python (xapp-frame-py) |
| Go | xApp Framework for Go (xapp-frame) |
| C++ | xApp Framework for CXX (xapp-frame-cpp) |
Project Readthedocs Page
The primary documentation for the frameworks should be on the Read The Docs site:
| Language | Read The Docs Link |
|---|---|
| Python | https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt- |
...
...
...
| index.html | |
| Go | |
| C++ | https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-xapp-frame-cpp/en/latest/user-guide.html |
Project README.md
https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt
...
/xapp-frame.git;a=blob;f=README.md;h=7a0cccc04ecf4a162c8a6b73d0c9c194181f3370;hb=refs/heads/master
https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/xapp-frame-cpp.git;a=blob;f=README;h=
...
e4dc3ffd28dcd2cb3fce4ee40da8e4419259fe07;hb=refs/heads/master
Primary Contact
...