Remove most doxygen file-level commands, copyrights, and authors
Remove the \file directive, as it is always superfluous because the current file is implicit [1]: > If the file name is omitted (i.e. the line after \file is left blank) > then the documentation block that contains the \file command will belong > to the file it is located in. Author names and e-mails are not relevant for us: it can always be inferred from git blame, and is often outdated. Eurecom code has been contributed and was under OAI PL v1.0/v1.1. For the cpack package contact: put generic email address that is independent of an individual and that will remain reachable. [1] https://www.doxygen.nl/manual/commands.html#cmdfile
This commit is contained in:
Robert Schmidt
@@ -19,15 +19,9 @@
|
||||
# * contact@openairinterface.org
|
||||
# */
|
||||
#! \file common/utils/websrv/CMakelists.txt
|
||||
|
||||
#* \brief: build rules and checks for web server shared libraries
|
||||
#* \author Francois TABURET
|
||||
#* \date 2023
|
||||
#* \version 1.0
|
||||
#* \company NOKIA BellLabs France
|
||||
#* \email: francois.taburet@nokia-bell-labs.com
|
||||
#* \note
|
||||
#* \warning
|
||||
#*/
|
||||
|
||||
find_library(ULFIUS NAMES "libulfius.so" REQUIRED)
|
||||
if (NOT ULFIUS)
|
||||
message(FATAL_ERROR "ulfius library (https://github.com/babelouest/ulfius) not found, install libulfius-dev (ubuntu) if you need to build websrv back-end")
|
||||
|
||||
@@ -19,17 +19,10 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/api/commands.api.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \api's definitions for the commands module, which provides web interface to telnet server commands
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {HttpClient} from "@angular/common/http";
|
||||
import {Injectable} from "@angular/core";
|
||||
import {environment} from "src/environments/environment";
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/api/help.api.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \api's definitions for the help module, which can be used to provides help text via tooltips
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {HttpClient} from "@angular/common/http";
|
||||
import {Injectable} from "@angular/core";
|
||||
import {Observable} from "rxjs";
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/api/info.api.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \api's definitions for the info module, which provides global info about the connected oai modem
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {HttpClient} from "@angular/common/http";
|
||||
import {Injectable} from "@angular/core";
|
||||
import {environment} from "src/environments/environment";
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/scope/scope.api.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \api's definitions for the scope module, which provides a web interface to the oai soft scope
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {HttpClient} from "@angular/common/http";
|
||||
import {Injectable} from "@angular/core";
|
||||
import {environment} from "src/environments/environment";
|
||||
|
||||
@@ -19,16 +19,10 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/app-routing-module.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {NgModule} from "@angular/core";
|
||||
import {RouterModule, Routes} from "@angular/router";
|
||||
|
||||
|
||||
@@ -20,18 +20,12 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/app.component.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \this is the frontend initial web page source code
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
|
||||
<mat-tab-group backgroundColor="primary" color="accent">
|
||||
<mat-tab label="Info">
|
||||
<app-info></app-info>
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/app.module.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \all components, (externals or devlopped for oai) used by the application are imported from here
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {DragDropModule} from "@angular/cdk/drag-drop";
|
||||
import {HttpClientModule} from "@angular/common/http";
|
||||
import {NgModule} from "@angular/core";
|
||||
|
||||
@@ -20,18 +20,12 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/commands/commands.component.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \commands web interface implementation (works with commands.component.ts)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
|
||||
<div class="grid-container" >
|
||||
<mat-grid-list cols="2" rowHeight="12vh" >
|
||||
<mat-grid-tile [colspan]="2" [rowspan]="2">
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/commands/commands.component.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \commands web interface implementation (works with commands.component.html)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {Component} from "@angular/core";
|
||||
import {route, IArgType, IInfo} from "src/commondefs";
|
||||
import {ViewEncapsulation} from "@angular/core";
|
||||
|
||||
@@ -20,18 +20,12 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/info/info.component.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \info component web interface implementation (works with info.component.ts)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
|
||||
<div class="grid-container" >
|
||||
<mat-grid-list cols="1" rowHeight="15vh" >
|
||||
<mat-grid-tile [colspan]="1" [rowspan]="6" >
|
||||
|
||||
@@ -19,17 +19,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/info/info.component.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \info component web interface implementation (works with info.component.html)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {Component} from "@angular/core";
|
||||
import {IArgType, IInfo} from "src/commondefs";
|
||||
import {ViewEncapsulation} from "@angular/core";
|
||||
|
||||
@@ -20,16 +20,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/question/question.component.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \utility component used to allow entering parameters before sending a request to the backend
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
<h3>{{ data.control.cmdname }} command parameters</h3>
|
||||
|
||||
@@ -20,17 +20,11 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/question/question.component.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \utility component used to allow entering parameters before sending a request to the backend
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {Component, Inject} from "@angular/core";
|
||||
import {MAT_DIALOG_DATA, MatDialogRef} from "@angular/material/dialog";
|
||||
import {CmdCtrl} from "src/app/controls/cmd.control";
|
||||
|
||||
@@ -20,16 +20,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/scope/scope.component.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \scope component web interface implementation (works with scope.component.ts)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
<div class="grid-container">
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/components/scope/scope.component.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \scope component web interface implementation (works with scope.component.html)
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {Component, EventEmitter, OnDestroy, OnInit, Output, QueryList, ViewChildren} from "@angular/core";
|
||||
import {Chart, ChartConfiguration} from "chart.js";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/cmd.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement a command for commands component
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
import {UntypedFormArray, UntypedFormControl, UntypedFormGroup} from "@angular/forms";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/info.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement one info item for info component
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {UntypedFormControl, UntypedFormGroup} from "@angular/forms";
|
||||
import {IArgType, IInfo} from "src/commondefs";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/module.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement one module item for commands component
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {UntypedFormArray, UntypedFormGroup} from "@angular/forms";
|
||||
import {IModule} from "../api/commands.api";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/param.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement one parameter in a result row for commands component
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {UntypedFormControl, UntypedFormGroup} from "@angular/forms";
|
||||
import {IArgType, IInfo} from "src/commondefs";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/row.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement one row results for commands component
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {FormControl, UntypedFormArray, UntypedFormGroup} from "@angular/forms";
|
||||
import {IArgType} from "src/commondefs";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/controls/var.control.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \implement one variable item for commands componen
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {UntypedFormControl, UntypedFormGroup} from "@angular/forms";
|
||||
import {IArgType, IInfo} from "src/commondefs";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/interceptors/error.interceptor.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \utility to intercept error response from backend and possibly dispay an error to user
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {HttpErrorResponse, HttpEvent, HttpHandler, HttpInterceptor, HttpRequest, HttpResponse} from "@angular/common/http";
|
||||
import {Injectable} from "@angular/core";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/services/download.service.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \utility to download a file from backend
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {HttpClient} from "@angular/common/http";
|
||||
import {HttpHeaders} from "@angular/common/http";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/app/services/websocket.service.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \utility implementing a web interface with the backend
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {Injectable} from "@angular/core";
|
||||
import {webSocket, WebSocketSubject} from "rxjs/webSocket";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/commondefs.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \definitions of constants, enums and interfaces common to the whole frontend
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
export enum IArgType {
|
||||
boolean = "boolean",
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/frontend/src/main.ts
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \this is the frontend application main source but interesting things atarts in the app.module import
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
import {enableProdMode} from "@angular/core";
|
||||
import {platformBrowserDynamic} from "@angular/platform-browser-dynamic";
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_channelid.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
This option asks for a model id and lists the parameters of this model. Some parameters can be then modified
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_current.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
When a oai component, as the rf simulator, instanciates a channel model, the instanciation is added in the list of current models. The id of the instanciation is used when using the "show channelid" option.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/cmd_channelmod_show_predef.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Predefined channel model are a set of modelisation algorithm's, identified by a name, available in oai code.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/question_setdistance_input.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags can be used in this help files as it is rendered in a div (tooltips don't work well in dialogs)
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
<ol>
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/question_show_channelid_input.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags can be used in this help files as it is rendered in a div (tooltips don't work well in dialogs)
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
channel index: channel model index in the channel modelisation module, it is printed when listing all defined models using the "show current" button.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_algorithm.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Available channel modelisation algorithm's can be listed using the "channelmod"/"show predef" command. A more convenient mechanism to select this will be implemented in a next version.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_model_index.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
The model index can be used to modify a model parameter, using the "channelmod"/"show channelid" commands
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_model_name.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Models parameters are defined in the oai configuration file under the section "channelmod.<channel list>". <channel list> describes the parameters for each <model name>. Several <channel list> can be defined, the loaded list is defined by the "channelmod.modellist" parameter. Model names are defined by the channel modelisation "user": for example the model "rfsmu_channel_ue0" is applied by the gNB rfsimulator on the signal received from ue0, the first connecet UE.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/rfsimu_show_models_module_owner.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
When the rfsimulator is effectively using a channel model to modify a received signal he becomes the owner of that model.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/scope_control_dataack.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
when enabled, back-end will stop sending data when too much data have not been acknowledge by the frontend. Currently the back-end limits to 200 the number of data messages waitting for ack.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_nice.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Nice value, relevant for other and batch scheduling can be changed via the "oai priority" field
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_sched_oai_priority.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
the oai priority field is used to provide the linux scheduling mode, priority and nice value in a single field.
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_priority.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
Linux priority field, relevant for real-time scheduling mode (Round-Robin or fifo) can be modified using the "oai priority" field
|
||||
|
||||
@@ -19,16 +19,9 @@
|
||||
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
/*! \file common/utils/websrv/helpfiles/softmodem_show_threadsched_sched_policy.html
|
||||
/*!
|
||||
* \brief: implementation of web interface frontend for oai
|
||||
* \help file loaded at run time using the help api's
|
||||
* \author: Yacine El Mghazli, Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: yacine.el_mghazli@nokia-bell-labs.com francois.taburet@nokia-bell-labs.com
|
||||
* \note: html tags cannot be used in this help files as it is rendered in a tooltips
|
||||
* \warning
|
||||
*/
|
||||
-->
|
||||
scheduling policy can be modified using the "oai priority" field.
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv.c
|
||||
/*!
|
||||
* \brief: implementation of web API
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
#include <libgen.h>
|
||||
#include <jansson.h>
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv.h
|
||||
/*!
|
||||
* \brief: implementation of web API
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
#ifndef WEBSRV_H
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv_noforms.c
|
||||
/*!
|
||||
* \brief: primitives replacing xforms when compiling nr_phy_scope.c for the webserver shared lib
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
#include <stdlib.h>
|
||||
#include <jansson.h>
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv_noforms.h
|
||||
/*!
|
||||
* \brief: include file to replace forms.h when compiling nr_phy_scope.c for the webserver shared lib
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
#ifndef FL_FORMS_H
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv_scope.c
|
||||
/*!
|
||||
* \brief: implementation of web API specific for oai softscope
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
#include <libgen.h>
|
||||
#include <jansson.h>
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv_utils.c
|
||||
/*!
|
||||
* \brief: utility functions for all websrv back-end sources
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
#include <unistd.h>
|
||||
#include <errno.h>
|
||||
|
||||
@@ -19,15 +19,8 @@
|
||||
* contact@openairinterface.org
|
||||
*/
|
||||
|
||||
/*! \file common/utils/websrv/websrv_websockets.c
|
||||
/*!
|
||||
* \brief: implementation of web/websockets API
|
||||
* \author Francois TABURET
|
||||
* \date 2022
|
||||
* \version 0.1
|
||||
* \company NOKIA BellLabs France
|
||||
* \email: francois.taburet@nokia-bell-labs.com
|
||||
* \note
|
||||
* \warning
|
||||
*/
|
||||
|
||||
#include <gnutls/gnutls.h>
|
||||
|
||||
Reference in New Issue
Block a user