LUDOC-297 protocol: Update protocol document

[doc/protocol.git] / struct_obd_export.txt

diff --git a/export.txt b/struct_obd_export.txt
similarity index 96%
rename from export.txt
rename to struct_obd_export.txt
index 0b3797c..c7e1636 100644 (file)
--- a/export.txt
+++ b/struct_obd_export.txt
@@ -1,6 +1,6 @@
 Export
 ^^^^^^
-[[obd-export]]
+[[struct-obd-export]]
 
 An 'obd_export' structure for a given target is created on a server
 for each client that connects to that target. The exports for all the
@@ -93,8 +93,8 @@ struct obd_export {
 
 The 'exp_handle' holds the cookie that the server generates at
 *_CONNECT time to uniquely identify this connection from the client.
-This cookie is also sent back to the client in the reply and is
-then stored in the client's import.
+This cookie is also sent back to the client in the *_CONNECT reply and
+is then stored in the client's import.
 
 //////////////////////////////////////////////////////////////////////
 ////vvvv
@@ -117,8 +117,10 @@ include::struct_obd_uuid.txt[]
 
 The 'exp_client_uuid' holds the UUID of the client connected to this
 export.  This UUID is randomly generated by the client and the same
-UUID is used by the client for connecting to all servers, so that
-the servers may identify the client amongst themselves if necessary.
+UUID is used by the client for connecting to all servers, so that the
+servers may identify the client amongst themselves if necessary. The
+client's UID appears in the *_CONNECT message (See
+<<ost-connect-rpc>>, <<mds-connect-rpc>>, and <<mgs-connect-rpc>>).
 
 //////////////////////////////////////////////////////////////////////
 ////vvvv
@@ -201,8 +203,10 @@ The 'exp_connect_data' refers to an 'obd_connect_data' structure for
 the connection established between this target and the client this
 export refers to.  The 'exp_connect_data' describes the mutually
 supported features that were negotiated between the client and server
-at connect time.  See also the corresponding entry in the import and
-in the connect messages passed between the hosts.
+at connect time.  See also the corresponding entry in the import
+(<<struct-obd-import>>) and the connect messages
+(<<ost-connect-rpc>>, <<mds-connect-rpc>>, and <mgs-connect-rpc>>)
+passed between the hosts.
 
 //////////////////////////////////////////////////////////////////////
 ////vvvv