BIND 10 #2938: Hooks framework design

[BIND 10 Development]

#2938: Hooks framework design
-------------------------------------+-------------------------------------
            Reporter:  stephen       |                        Owner:  tmark
                Type:  task          |                       Status:
            Priority:  medium        |  reviewing
           Component:  Unclassified  |                    Milestone:
            Keywords:                |  Sprint-DHCP-20130821
           Sensitive:  0             |                   Resolution:
         Sub-Project:  DHCP          |                 CVSS Scoring:
Estimated Difficulty:  0             |              Defect Severity:  N/A
         Total Hours:  0             |  Feature Depending on Ticket:
                                     |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------

Comment (by tmark):

 Comments are largely minor corrections.  I did create a more detailed
 class diagram for you
 and attached it to this ticket, if you wish to use it.  It was helpful to
 my understanding, and imagine others would find it of some value.


 In the example code under "Callout Arguments" section,

 Change this phrase:

 'and does not require a "set".'  to  'and does not require a
 "setArgument."'

 I had read it a couple of times before the "light bulb" went on.
 ----------------------------------------------------------------------------
 "User-Side Objects"

 This paragraph:

 "As far as user-library code is concerned, two objects are important: the
 LibraryHandle and the CalloutHandle. The former allows registration of
 callouts, whereas the latter is the mechanism by which data are passed
 between the server and library, and between callouts in the library on a
 per-request basis."

 I'd suggest replacing "former" and "latter"  second sentence and with the
 object
 names themselves.

 ----------------------------------------------------------------------------

 Under Restrictions on Callout Registration:

 "Firstly, a callout can be deregistered a function"

 insert missing "by":

 "Firstly, a callout can be deregistered by a function"

 ----------------------------------------------------------------------------

 Under Per-Request Callout Handle:

 "Gets/sets per-query (or pre-packet) context."

 change "pre" to "per":

 "Gets/sets per-query (or per-packet) context."

 ----------------------------------------------------------------------------

 Under Per-Request Callout Handle:

 "These methods gets and set the arguments"

 change "gets" to "get":

 "These methods get and set the arguments"

 ----------------------------------------------------------------------------

 Under Per-Request Callout Handle:

 "instead the code immediately call the pd_lease_assign_post hook"

 insert missing "would":

 "instead the code would immediately call the pd_lease_assign_post hook"

 ----------------------------------------------------------------------------

 Under Per-Request Callout Handle:

 "a reference to the libraryt handle."

 change "libraryt" to "library"


 ----------------------------------------------------------------------------

 Under Server-Side Objects:

 "LibraryHandle is contains little more"

 remove extraneous "is"

 "LibraryHandle contains little more"

 ----------------------------------------------------------------------------

 Under LibraryManager

 "using the associated LibraryHandle's registerHook()"

 add a "!" in front of LibraryHandle.

 ----------------------------------------------------------------------------

 Under LibraryManager

 "the associated shared library will be close."

 change "be close." to "be closed."

-- 
Ticket URL: <http://bind10.isc.org/ticket/2938#comment:7>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development