blob: b666b23e542fde9823b772a0c434c9521dfeabef [file] [log] [blame]
subhash kumar singh811df742021-03-26 15:07:55 +05301.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. SPDX-License-Identifier: CC-BY-4.0
3.. Copyright (c) 2021 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2021
4
5============================================================================================
6HW-go xAPP (golang)
7============================================================================================
8--------------------------------------------------------------------------------------------
9User's Guide
10--------------------------------------------------------------------------------------------
11
12Introduction
13============================================================================================
14
15The RIC platform provides set of functions as part of xAPP golang Framework that the xAPPs can use to accomplish their tasks.
16This xAPP is envisioned to provide python xAPP developers, examples of implementing these sets of functions.
17Note, HW-go xAPP does not address/implement any RIC Usecases.
18
19HW-go xAPP Features
20============================================================================================
21
22RIC Platform provides many Frameworks, APIs and libraries to aid the development of xAPPs. All xAPPs will have some custom
23processing functional logic core to the xApp and some additional non-functional platform related processing using
24these APIs and libraries. This xAPP attempts to show the usage of such additional platform processing using xapp RIC framework APIs and libraries.
25
26
27The HW-go xAPP demonstrates how a golang based xApp uses the A1, and E2 interfaces and persistent database read-write operations.
28