X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_alloc_msg.3.xfm;h=cd9da7f65b3930f1d34826de3cdf1df160cfa36b;hb=refs%2Fchanges%2F89%2F589%2F1;hp=04b908b7f61c9b1047f77f628af935502b916cab;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_alloc_msg.3.xfm b/doc/src/man/rmr_alloc_msg.3.xfm index 04b908b..cd9da7f 100644 --- a/doc/src/man/rmr_alloc_msg.3.xfm +++ b/doc/src/man/rmr_alloc_msg.3.xfm @@ -23,22 +23,10 @@ Date 28 January 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) - &h1(RMR Library Functions) &h2(NAME) rmr_alloc_msg @@ -48,7 +36,7 @@ &ex_start #include -rmr_mbuf_t* rmr_alloc_msg( void* a, int size ); +rmr_mbuf_t* rmr_alloc_msg( void* ctx, int size ); &ex_end &uindent @@ -59,7 +47,7 @@ The buffer is allocated such that sending it requires no additional copying out of the buffer. If the value passed in &cw(size) is 0, then the default size supplied on the &ital(rmr_init) call will be used. -The &ital(a) parameter is the void context pointer that was returned by +The &ital(ctx) parameter is the void context pointer that was returned by the &ital(rmr_init) function. &space @@ -74,7 +62,7 @@ typedef struct { int mtype; int len; unsigned char* payload; - unsigned char* a; + unsigned char* xaction; } rmr_mbuf_t; &ex_end @@ -113,12 +101,12 @@ should &bold(NOT) make use of the payload pointer. &half_space -&ditem(a ) The &ital(a) field is a pointer to a fixed sized area in +&ditem(xaction) The &ital(xaction) field is a pointer to a fixed sized area in the message into which the user may write a transaction ID. The ID is optional with the exception of when the user application uses the &cw(rmr_call) function to send a message and wait for the reply; the underlying RMR processing expects that the matching reply message will also contain the same data in the -&ital(a) field. +&ital(xaction) field. &end_dlist &h2(RETURN VALUE) @@ -132,10 +120,13 @@ The function returns a pointer to a &cw(rmr_mbuf) structure, or NULL on error. .** &h2(EXAMPLE) &h2(SEE ALSO ) -rmr_mbuf(3) +rmr_tralloc_msg(3), rmr_call(3), rmr_free_msg(3), rmr_init(3), +rmr_init_trace(3), +rmr_get_trace(3), +rmr_get_trlen(3), rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), @@ -146,8 +137,8 @@ rmr_fib(3), rmr_has_str(3), rmr_tokenise(3), rmr_mk_ring(3), -rmr_ring_free(3) - +rmr_ring_free(3), +rmr_set_trace(3) .qu