Project

General

Profile

Actions

Bug #4325

closed

rpc_svc_calls(3nsl): svc_getrpccaller() description should be improved

Added by Marcel Telka over 7 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
manpage - manual pages
Start date:
2013-11-13
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
needs-triage
Gerrit CR:

Description

In the rpc_svc_calls(3nsl) man page there is this description of svc_getrpccaller():

     struct netbuf *svc_getrpccaller(const SVCXPRT *xprt);
     The svc_getrpccaller() function is the approved way of  get-
     ting  the network address of the caller of a procedure asso-
     ciated with the RPC  service  transport  handle  xprt.  This
     function macro is Safe in multithreaded applications.

There are two minor issues with it:

  1. The svc_getrpccaller() is not a macro.
  2. It is not clear whether the svc_getrpccaller() returns an allocated copy of struct netbuf, or not. IOW, it is not clear whether the svc_getrpccaller() caller should deallocate the returned netbuf, or not. To avoid confusion, it should be stated in the man page that the returned netbuf shouldn't be deallocated by the svc_getrpccaller() caller.
Actions #1

Updated by Marcel Telka over 7 years ago

Okay, svc_getrpccaller() is a macro defined in svc.h. The svc_getrpccaller() function definition in svid_funcs.c is there only for compatibility reasons.

Actions #2

Updated by Marcel Telka over 6 years ago

  • Category set to manpage - manual pages
  • Status changed from New to In Progress
  • Assignee set to Marcel Telka
Actions #3

Updated by Marcel Telka over 6 years ago

  • Status changed from In Progress to Pending RTI
Actions #4

Updated by Electric Monk over 6 years ago

  • Status changed from Pending RTI to Closed
  • % Done changed from 0 to 100

git commit db26b99f059a8c142f2792443c9feacf20492ce7

commit  db26b99f059a8c142f2792443c9feacf20492ce7
Author: Marcel Telka <marcel.telka@nexenta.com>
Date:   2014-11-24T21:41:53.000Z

    4325 rpc_svc_calls(3nsl): svc_getrpccaller() description should be improved
    Reviewed by: Richard Lowe <richlowe@richlowe.net>
    Reviewed by: Gordon Ross <gordon.ross@nexenta.com>
    Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
    Approved by: Dan McDonald <danmcd@omniti.com>

Actions

Also available in: Atom PDF