Eliminate the SI receive buffer length requirement

[ric-plt/lib/rmr.git] / doc / src / man / rmr_alloc_msg.3.xfm

diff --git a/doc/src/man/rmr_alloc_msg.3.xfm b/doc/src/man/rmr_alloc_msg.3.xfm
index 44bcce0..cbd3dc2 100644 (file)
--- a/doc/src/man/rmr_alloc_msg.3.xfm
+++ b/doc/src/man/rmr_alloc_msg.3.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia
-       Copyright (c) 2018-2019 AT&T Intellectual Property.
+   Copyright (c) 2019 Nokia
+   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.
@@ -17,10 +17,10 @@
 ==================================================================================
 .fi
 .if false
-       Mnemonic        rmr_alloc_msg.xfm
-       Abstract        The manual page for the rmr_alloc_msg function.
-       Author          E. Scott Daniels
-       Date            28 January 2019
+    Mnemonic    rmr_alloc_msg.xfm
+    Abstract    The manual page for the rmr_alloc_msg function.
+    Author      E. Scott Daniels
+    Date        28 January 2019
 .fi
 
 .gv e LIB lib
@@ -29,7 +29,7 @@
 &line_len(6i)
 &h1(RMR Library Functions)
 &h2(NAME)
-       rmr_alloc_msg
+    rmr_alloc_msg
 
 &h2(SYNOPSIS )
 &indent
@@ -45,8 +45,14 @@ The &cw(rmr_alloc_msg) function is used to allocate a buffer which the user
 programme can write into and then send through the RMR library.
 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.
+If the value passed in &cw(size) is less than or equal to 0, then the
+&ital(normal maximum size) supplied on the &ital(rmr_init) call will be used.
+When &ital(size) is greater than zero, the message allocated will have at least
+the indicated number of bytes in the payload.
+There is no maximum size imposed by RMR, however the underlying system memory
+managerment (e.g. malloc) functions may impose a limit.
+
+&space
 The &ital(ctx) parameter is the void context pointer that was returned by
 the &ital(rmr_init) function.
 
@@ -63,8 +69,8 @@ typedef struct {
     int len;
     unsigned char* payload;
     unsigned char* xaction;
-       int sub_id;
-       int tp_state;
+    int sub_id;
+    int tp_state;
 } rmr_mbuf_t;
 &ex_end