update docs for public release

Author: pinoOgni

Diff for: .gitignore

@@ -1,7 +1,7 @@
 polycube-grpc-cpp/build/*
-examples/cpp/pcn-helloworld2/build/*
+examples/cpp/pcn-helloworldcpp/build/*
 .vscode/*
 examples/go/pcn-helloworldgo/helloworldgo
 examples/go/pcn-transparenthelloworldgo/transparenthelloworldgo
 examples/go/skeleton-project/skeleton
-bash_tests/*
+bash_tests/*

Diff for: README.md

@@ -1,6 +1,12 @@
 # polycube-grpc-service-libraries
-GRPC libraries to allow the writing of a stand-alone Polycube service also in other languages
+GRPC libraries to allow the writing of a stand-alone Polycube service also in other languages. If you want to use it you need to use my [Polycube fork](https://github.com/pinoOgni/polycube) because I haven't had a chance to merge the code into the main repo yet. 
 
+# Current Status
+
+**WARNING**: I'm no longer active in the development of polycube-grpc-service-libraries an probably some documentation and some comments are missing. I still hope there is enough.
+
+
+# Repository organization
 
 This repository contains the client side grpc libraries to interface with Polycube and is composed as follows:
 

Diff for: examples/cpp/pcn-helloworld2/README.md

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.5.1)
-project (pcn-helloworld2)
+project (pcn-helloworldcpp)
 include(cmake/common.cmake)
 
 add_subdirectory(src)

Diff for: examples/cpp/pcn-helloworld2/CMakeLists.txt renamed to examples/cpp/pcn-helloworldcpp/CMakeLists.txt

@@ -0,0 +1,44 @@
+This is the first example of a grpc C++ service. Within this directory there are various types of files and directories.
+
+Directory:
+* cmake: contains the cmake useful for building the service
+* datamodel: contains the yang of the service (FOR NOW NOT USED)
+* src: Contains all the helloworld 1.0 service code and other files that make up the grpc service. Of all the files contained here, only the following are used:
+    * helloworldcpp_client.cc represents the CONTROLPLANE. Here is the main of the service and a few things need to be done to get everything to work:
+        * PolycubeClient polycubeclientgrpc; in this way we can use the methods of the polycube-grpc library (C++)
+        * use the RegisterHandlerHTTPVERB methods to associate the controlplane methods to a url
+        * launch the ReadTheStream method of the polycube-grpc library in a thread
+        * join the newly launched thread
+    * helloworldcpp_client.h represents the CONTROLPLANE.
+        * Here there is not only the prototype of the method but also the implementation. Each method that is implemented here and that needs to contact Polycube for its work, will have to make a call to a suitable method of the polycube-grpc library.
+        * For example, the Helloworld setAction method is used to set an action in the DATAPLANE that is to set a value in an eBPF map, this is reduced to calling the TableSet method with appropriate parameters.
+        * Note that there is also the create_cube method which is used to create a cube
+        * IMPORTANT: here, the developer will be able to decide the logic with which to manage the relationship between service and cube, so for example manage the cubes with IDs and have a vector of cubes or similar
+        * IMPORTANT: here, the developer must also manage the logic of the ports, obviously if the service has the concept of port in itself
+        * LESS IMPORTANT: right now in this file, the developer will also have to put the helpocommands method which will then be registered on the appropriate url and which returns a description on how to use the service from polycubectl
+    * Helloworldcpp_dp_egress.h, Helloworldcpp_dp_egress.c Helloworldcpp_dp_ingress.h and Helloworldcpp_dp_ingress.c which correspond to the dataplane
+    * Helloworldcpp-lib.cpp, Helloworldcpp.cpp, Helloworldcpp.h, Ports.cpp and Ports.h NOW as of now they are not needed, I don't know if they will be used in the future
+* first_client.cc, first_polycube_client.cc, router_client.cc and second_client.cc DO NOT do the service but are test files
+
+
+NOTE: To make everything work, you will need to include the polycube-grpc library in the controlplane files
+
+
+
+
+
+
+# Examples gRPC remote services in C++
+
+##
+
+
+
+
+
+
+## Observations
+
+Within each example, for logic reasons, or because it is still being implemented, there are some directories or files that are not necessary to develop a simple service. In particular, the directories
+* cmake: contains some files for loading the files as variables and another one used for the compiler of gRPC/ProtoBuf
+* datamodel: contains the datamodel of the Polycube helloworld service

Diff for: examples/cpp/pcn-helloworldcpp/README.md

@@ -1,17 +1,17 @@
-module helloworld2 {
+module helloworldcpp {
   yang-version 1.1;
-  namespace "http://polycube.network/helloworld2";
-  prefix "helloworld2";
+  namespace "http://polycube.network/helloworldcpp";
+  prefix "helloworldcpp";
 
   import polycube-base { prefix "polycube-base"; }
   import polycube-standard-base { prefix "polycube-standard-base"; }
 
   organization "Polycube open source project";
-  description "YANG data model for the Polycube Helloworld2 service";
+  description "YANG data model for the Polycube Helloworldcpp service";
 
-  polycube-base:service-description "Helloworld2 Service";
+  polycube-base:service-description "Helloworldcpp Service";
   polycube-base:service-version "2.0";
-  polycube-base:service-name "helloworld2";
+  polycube-base:service-name "helloworldcpp";
   polycube-base:service-min-kernel-version "4.14.0";
 
   uses "polycube-standard-base:standard-base-yang-module";