docs/user-guide.rst

   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
  15 Class RMRXapp
  16 -------------
  17
  18 Application writers should extend this class to implement a reactive Xapp;
  19 also see class Xapp.
  20
  21 .. autoclass:: ricxappframe.xapp_frame.RMRXapp
  22     :members:
  23
  24 Class Xapp
  25 ----------
  26
  27 Application writers should extend this class to implement a general Xapp;
  28 also see class RMRXapp.
  29
  30 .. autoclass:: ricxappframe.xapp_frame.Xapp
  31     :members:
  32
  33
  34 Class SDLWrapper
  35 ----------------
  36
  37 Application writers may instantiate this class directly to communicate with the SDL service.
  38
  39 .. autoclass:: ricxappframe.xapp_sdl.SDLWrapper
  40     :members: