Reorganise the sidecars

[ric-app/mc.git] / sidecars / listener / mcl.h

diff --git a/sidecars/listener/mcl.h b/sidecars/listener/mcl.h
new file mode 100644 (file)
index 0000000..37f13f0
--- /dev/null
+++ b/sidecars/listener/mcl.h
@@ -0,0 +1,74 @@
+// vim: ts=4 sw=4 noet:
+/*
+ --------------------------------------------------------------------------------
+       Copyright (c) 2018-2019 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.
+ --------------------------------------------------------------------------------
+
+/*
+       Mnemonic:       mcl.h
+       Abstract:       Header file for the mc listener library.
+       Date:           22 August 2019
+       Author:         E. Scott Daniels
+       
+*/
+
+#ifndef mcl_h
+#define mcl_h
+
+#include <rmr/rmr.h>
+#include <rmr/rmr_symtab.h>
+
+// ------- public constants and structs -------------------------------------------------------------------
+
+#define MCL_LEN_SIZE 8         // number of bytes the length has in both short and extended header
+#define MCL_DELIM_SIZE 4       // number of bytes in extended header delimiter
+#define MCL_TSTAMP_SIZE        16      // number of bytes in extended header timestamp
+#define MCL_EXHDR_SIZE (MCL_DELIM_SIZE+MCL_LEN_SIZE+MCL_TSTAMP_SIZE)   // total size of extended header
+
+#define MCL_DELIM              "@MCL"          // delimeter to synch msgs in fifo
+
+#define MCL_TSTAMP_OFF (MCL_DELIM_SIZE+MCL_LEN_SIZE)                                   // offsets in header
+#define MCL_LEN_OFF            MCL_DELIM_SIZE
+
+#define MCL_NOWAIT     0       // do not wait for RMR route table to arrive
+#define MCL_WAIT       1       // block reader start until RMR route table is initialised
+
+// ---- rdc definitions ----------------------------------------------------------------------------------
+#define LOG_CRIT       0
+#define LOG_ERR                1
+#define LOG_WARN       2
+#define LOG_INFO       3
+#define LOG_STAT       4               // stats messages go to stdout
+
+
+//------------ prototypes --------------------------------------------------------------
+extern void mcl_fifo_fanout( void* ctx, int report, int long_hdrs );
+extern rmr_mbuf_t* mcl_get_msg( void* vctx, rmr_mbuf_t* msg, int timeout );
+extern void* mcl_mk_context( char* dir );
+extern int mcl_fifo_read1( void* vctx, int mtype, char* ubuf, int ublen, int long_hdr );
+extern int mcl_fifo_tsread1( void* vctx, int mtype, char* ubuf, int ublen, int long_hdr, char* timestamp );
+extern int mcl_set_sigh( );
+extern int mcl_start_listening( void* vctx, char* port, int wait4ready );
+
+// ---- these can be used by external programmes, but it liekely doesn't make sense to do so ----
+extern void logit( int level, char* fmt, ... );
+extern void* rdc_init( char* sdir, char* fdir, char* suffix, char* dsuffix );
+extern void* rdc_init_buf( int mtype, char* uheader, int uhlen, void* capture_buf );
+extern void rdc_close( void* rdl_ctx );
+extern void rdc_set_freq( void* rdl_ctx, int freq );
+extern int rdc_write( void* rdl_ctx, void* rdc_buffer, char* payload, int len );
+
+
+#endif