| Lott, Christopher (cl778h) | ca170d3 | 2020-05-12 15:05:59 -0400 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. SPDX-License-Identifier: CC-BY-4.0 |
| 3 | .. Copyright (C) 2020 AT&T Intellectual Property |
| 4 | |
| 5 | User Guide |
| 6 | ========== |
| 7 | |
| 8 | This document explains how to develop an Xapp using the RIC Xapp framework. |
| 9 | Information for maintainers of this framework is in the Developer Guide. |
| 10 | |
| 11 | Xapp writers should use the public classes and methods from the Xapp Python |
| 12 | framework package as documented below. |
| 13 | |
| 14 | |
| Lott, Christopher (cl778h) | e87ea19 | 2020-06-16 16:12:26 -0400 | [diff] [blame^] | 15 | Class _BaseXapp |
| 16 | --------------- |
| 17 | |
| 18 | Although this base class should not be used directly, it is inherited by |
| 19 | the public classes shown below and all of this class's public methods are |
| 20 | available for use by application writers. |
| 21 | |
| 22 | .. autoclass:: ricxappframe.xapp_frame._BaseXapp |
| 23 | :members: |
| 24 | |
| 25 | |
| Lott, Christopher (cl778h) | ca170d3 | 2020-05-12 15:05:59 -0400 | [diff] [blame] | 26 | Class RMRXapp |
| 27 | ------------- |
| 28 | |
| 29 | Application writers should extend this class to implement a reactive Xapp; |
| 30 | also see class Xapp. |
| 31 | |
| 32 | .. autoclass:: ricxappframe.xapp_frame.RMRXapp |
| 33 | :members: |
| 34 | |
| 35 | Class Xapp |
| 36 | ---------- |
| 37 | |
| 38 | Application writers should extend this class to implement a general Xapp; |
| 39 | also see class RMRXapp. |
| 40 | |
| 41 | .. autoclass:: ricxappframe.xapp_frame.Xapp |
| 42 | :members: |
| 43 | |
| 44 | |
| 45 | Class SDLWrapper |
| 46 | ---------------- |
| 47 | |
| 48 | Application writers may instantiate this class directly to communicate with the SDL service. |
| 49 | |
| 50 | .. autoclass:: ricxappframe.xapp_sdl.SDLWrapper |
| 51 | :members: |