BIND 10 #301: Review result for auth

[BIND 10 Development]

#301: Review result for auth
--------------------------+-------------------------------------------------
  Reporter:  zhanglikun   |            Owner:  jinmei
      Type:  enhancement  |           Status:  new   
  Priority:  major        |        Milestone:        
 Component:  b10-auth     |         Keywords:        
 Sensitive:  0            |   Estimatedhours:  0     
     Hours:  0            |         Billable:  1     
Totalhours:  0            |         Internal:  0     
--------------------------+-------------------------------------------------
 The following comments was inputted by stephen for ticket #289, so
 seperated it to one single ticket, maybe jinmei is the best person for
 accepting this ticket.


 src/bin/auth/auth_srv.cc
 With very similar names (AuthSrv and AuthSrvImpl), it might be clearer to
 put the declaration and implementation of AuthSrvImpl into separate files.


 The AuthSrv setXxxx and getXxxx functions are sufficiently trivial that
 consideration could be given to defining them inline in the header file.


 Check with Jerry Chen about recent (9 August 2010) changes to this file
 (in processAxfrQuery) concerning problems with AXFRs failing because of
 connection problems.


 src/bin/auth/auth_srv.h
 A header describing the purpose of the class would be useful.


 Remark: all methods (not just ones changed by this update) should have a
 doxygen header.


 setXfrinSession: looks as if the last line of the header comment is
 missing.


 src/bin/auth/asio_link.cc
 The asio_link.h file contains the class definitions for the wrapper around
 ASIO. However, the file asio_link.cc contains additional classes (such as
 TCPClient) that know about the application. I suggest that asio_link.cc
 contain only those classes and functions relating to the wrapper interface
 and that the other classes be moved to a separate file. This will make it
 easier for asio_link to be used elsewhere.


 Header documentation for the helper classes (e.g. what is their purpose
 and the purpose of their methods) should be provided.


 src/bin/auth/asio_link.h
 OK. Documentation is good.

-- 
Ticket URL: <http://bind10.isc.org/ticket/301>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development