Initial source commit

[ric-plt/xapp-frame-cpp.git] / examples / README

diff --git a/examples/README b/examples/README
new file mode 100644 (file)
index 0000000..70f00ff
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,33 @@
+==================================================================================
+       Copyright (c) 2020 Nokia
+       Copyright (c) 2020 AT&T Intellectual Property.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================================
+
+This directory contains a few simple examples which illustrate
+the various ways that the xAPP-C++ framework (xfcpp) can be
+used.
+
+xapp_t1.cpp
+       A receiver which demonstrates how callbacks can be
+       declared and used to process specific messages.
+       Also demonstrates the simplicity of setting up an
+       xAPP which simply responds to received messages (a
+       total of 4 instuctions in main()).
+
+xapp_t2.cpp
+       A sender application which demonstrates how the framework
+       can be used for applications which are sending based
+       and need to check for responses. This does not involve
+       the use of callbacks or the frameworks "driver".