Add API allowing xAPPs to send alarm messages

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

diff --git a/examples/xapp_t1.cpp b/examples/xapp_t1.cpp
index 8cce435..5ec8536 100644 (file)
--- a/examples/xapp_t1.cpp
+++ b/examples/xapp_t1.cpp
@@ -23,8 +23,8 @@
        Abstract:       This is a simple demo xapp which registers 3 callback functions
                                (2 for specific message types, and one default callback). It
                                defaults to starting 1 thread, but can cause the xapp environment
-                               to start n listeners.  When running 1 thread it should emit 
-                               message countes ever few seconds with a crudly computed msg/sec 
+                               to start n listeners.  When running 1 thread it should emit
+                               message countes ever few seconds with a crudly computed msg/sec
                                receive rate value.
 
                                In addition, the callback for message type 1 will send two response
@@ -34,17 +34,20 @@
 
        Date:           18 March 2020
        Author:         E. Scott Daniels
-               
+
+       Caution:        This example code is pulled directly into one or more of the documents
+                               (starting from the "start-example" tag below.  Use caution with
+                               line lengths and contents because of the requirement that this
+                               be documentation as well as working code.
 */
+// start-example
 #include <stdio.h>
 
 #include "ricxfcpp/message.hpp"
 #include "ricxfcpp/msg_component.hpp"
 #include "ricxfcpp/xapp.hpp"
 
-// ----------------------------------------------------------
-
-// counts/time values for crude rate estimation; only valid when threads == 1
+// counts; not thread safe
 long cb1_count = 0;
 long cb2_count = 0;
 long cbd_count = 0;
@@ -52,34 +55,28 @@ long cbd_count = 0;
 long cb1_lastts = 0;
 long cb1_lastc = 0;
 
-void cb1( Messenger& mr, Message& mbuf, int mtype, int subid, int len, Msg_component payload,  void* data ) {
+// respond with 2 messages for each type 1 received
+void cb1( xapp::Message& mbuf, int mtype, int subid, int len,
+                       xapp::Msg_component payload,  void* data ) {
        long now;
        long total_count;
 
-       //fprintf( stderr, "callback 1 got a message type = %d len = %d\n", mtype, len );
-       mbuf.Send_response( 101, -1, 5, (unsigned char *) "OK1\n" );    // validate that we can use the same buffer for 2 rts calls
+       // illustrate that we can use the same buffer for 2 rts calls
+       mbuf.Send_response( 101, -1, 5, (unsigned char *) "OK1\n" );
        mbuf.Send_response( 101, -1, 5, (unsigned char *) "OK2\n" );
+
        cb1_count++;
-       
-       now = time( NULL );
-       if( now - cb1_lastts > 5 ) {                            // crude rate estimation starting with second timer pop
-               if( cb1_lastts ) {
-                       total_count = cb1_count + cb2_count;
-                       fprintf( stderr, "cb1: %ld  diff=%ld ~rate=%ld\n", total_count, now - cb1_lastts, (total_count-cb1_lastc)/(now - cb1_lastts) );
-                       cb1_lastc = total_count;
-               }
-               cb1_lastts = now;
-       }
 }
 
-void cb2( Messenger& mr, Message& mbuf, int mtype, int subid, int len, Msg_component payload,  void* data ) {
-       //fprintf( stderr, "callback 2 got a message type = %d len = %d\n", mtype, len );
-       //mbuf.Send_msg( 101, -1, 4, (unsigned char *) "HI\n" );                // send, including the trailing 0
+// just count messages
+void cb2( xapp::Message& mbuf, int mtype, int subid, int len,
+                       xapp::Msg_component payload,  void* data ) {
        cb2_count++;
 }
 
-void cbd( Messenger& mr, Message& mbuf, int mtype, int subid, int len, Msg_component payload,  void* data ) {
-       //fprintf( stderr, "default callback  got a message type = %d len = %d\n", mtype, len );
+// default to count all unrecognised messages
+void cbd( xapp::Message& mbuf, int mtype, int subid, int len,
+                       xapp::Msg_component payload,  void* data ) {
        cbd_count++;
 }
 
@@ -89,15 +86,15 @@ int main( int argc, char** argv ) {
        int ai = 1;                                                     // arg processing index
        int nthreads = 1;
 
-       ai = 1;
-       while( ai < argc ) {                            // very simple flag processing (no bounds/error checking)
+       // very simple flag processing (no bounds/error checking)
+       while( ai < argc ) {
                if( argv[ai][0] != '-' )  {
                        break;
                }
 
                switch( argv[ai][1] ) {                 // we only support -x so -xy must be -x -y
-                       case 'p': 
-                               port = argv[ai+1];      
+                       case 'p':
+                               port = argv[ai+1];
                                ai++;
                                break;
 
@@ -109,14 +106,15 @@ int main( int argc, char** argv ) {
 
                ai++;
        }
-       
+
        fprintf( stderr, "<XAPP> listening on port: %s\n", port );
        fprintf( stderr, "<XAPP> starting %d threads\n", nthreads );
 
        x = new Xapp( port, true );
-       x->Add_msg_cb( 1, cb1, NULL );
+       x->Add_msg_cb( 1, cb1, NULL );                          // register callbacks
        x->Add_msg_cb( 2, cb2, NULL );
        x->Add_msg_cb( x->DEFAULT_CALLBACK, cbd, NULL );
 
-       x->Run( nthreads );
+       x->Run( nthreads );                             // let framework drive
+       // control should not return
 }