X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_wh_close.3.xfm;h=0fd388acf2c5253bf45d5db9aabaccc5f04f1922;hb=5157a97ada5447efcee4da6192798a3b6799884c;hp=fbd94cf960cca0f5e99c72e73e7af08b7a8c08e8;hpb=708ebac12488fe6fb204ff2861fc0045afb73b78;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_wh_close.3.xfm b/doc/src/man/rmr_wh_close.3.xfm index fbd94cf..0fd388a 100644 --- a/doc/src/man/rmr_wh_close.3.xfm +++ b/doc/src/man/rmr_wh_close.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. @@ -18,20 +18,20 @@ .fi .if false - Mnemonic rmr_wh_close.xfm - Abstract The manual page for the rmr_wh_close function. - Author E. Scott Daniels - Date 21 February 2019 + Mnemonic rmr_wh_close.xfm + Abstract The manual page for the rmr_wh_close function. + Author E. Scott Daniels + Date 21 February 2019 .fi .gv e LIB lib -.im &{lib}/man/setup.im +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_wh_open + rmr_wh_close &h2(SYNOPSIS) &indent @@ -45,13 +45,13 @@ void rmr_close( void* vctx, rmr_whid_t whid ) &h2(DESCRIPTION) The &cw(rmr_wh_close) function closes the wormhole associated with the wormhole id passed -in. +in. Future calls to &cw(rmr_wh_send_msg) with this ID will fail. &space -The underlying TCP connection to the remote endpoint is &bold(not) closed as this -session may be reqruired for regularlly routed messages (messages routed based on message -type). +The underlying TCP connection to the remote endpoint is &bold(not) closed as this +session may be required for regularly routed messages (messages routed based on message +type). There is no way to force a TCP session to be closed at this point in time.