Changes between Version 40 and Version 41 of ModParrotHLLDocs

Show
Ignore:
Timestamp:
01/18/09 17:51:20 (5 years ago)
Author:
jhorwitz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ModParrotHLLDocs

    v40 v41  
    5959=== Creating HLL Configurations === 
    6060 
    61 Each Apache module is responsible for defining and creating its own configuration data structures.  When Apache asks an HLL module for a server or directory configuration, mod_parrot will look for a "constructor" subroutine in the {{{ModParrot;HLL;hllname}}} namespace to execute.  Server configs are provided by {{{server_create}}}, while directory configs are provided by {{{dir_create}}}.  These subroutines should create a data structure, possibly populated with default values, and return it.  The type of the structure is up to the implementor, as long as it is a valid Parrot PMC. 
     61Each Apache module is responsible for defining and creating its own configuration data structures.  When Apache asks an HLL module for a server or directory configuration, mod_parrot will look for a "constructor" subroutine in the {{{ModParrot;HLL;hllname}}} namespace to execute.  Server configs are provided by {{{server_create}}}, while directory configs are provided by {{{dir_create}}}.  Both are passed a ModParrot;Apache;CmdParms object.  These subroutines should create a data structure, possibly populated with default values, and return it.  The type of the structure is up to the implementor, as long as it is a valid Parrot PMC. 
    6262 
    6363''Signatures'' 
    6464 
    65  * {{{PMC server_create()}}} 
    66  * {{{PMC dir_create()}}} 
     65 * {{{PMC server_create(PMC parms)}}} 
     66 * {{{PMC dir_create(PMC parms)}}} 
    6767 
    6868''Example: the PIR configuration constructors'' 
     
    7272 
    7373.sub server_create 
    74      $P0 = new 'Hash' 
    75      .return($P0) 
     74    .param pmc parms 
     75    $P0 = new 'Hash' 
     76    .return($P0) 
    7677.end 
    7778 
    7879.sub dir_create 
    79      $P0 = new 'Hash' 
    80      .return($P0) 
     80    .param pmc parms 
     81    $P0 = new 'Hash' 
     82    .return($P0) 
    8183.end 
    8284}}} 
     
    221223 
    222224{{{VOID callback(PMC dircfg, PMC args)}}} 
     225 * {{{parms}}}: the ModParrot;Apache;CmdParms object for this command 
    223226 * {{{dircfg}}}: the current directory configuration 
    224227 * {{{args}}}: an array of arguments 
     
    232235{{{ 
    233236.sub cmd_parrothandler 
     237    .param pmc parms 
    234238    .param pmc dircfg 
    235239    .param pmc args 
     
    250254{{{ 
    251255.sub cmd_parrotpostconfighandler 
     256    .param pmc parms 
    252257    .param pmc mconfig 
    253258    .param pmc args