RageIRCd v2.0 (bluemoon): Hook Subsystem API
--------------------------------------------

$Id: hook-api.txt,v 1.2.2.1 2005/02/21 02:32:45 amcwilliam Exp $
(C) 2000-2005 the RageIRCd Development Team, all rights reserved.

RageIRCd v2.0 incorporates a new hook subsystem, allowing external modules 
to plug into ircd in order to extend server functionality.

RageIRCd v2.0 contains a range of different hooks hard-coded into the 
standard distribution. These hooks allow dynamic modules to plug into 
ircd, providing a means for other developers to greatly extend the servers 
functionality.

In an attempt to provide a scalable solution, this system has been 
extended further still, to allow dynamic modules to register their own 
hooks. These hooks can then be plugged into by other modules.

NB. This document does NOT cover Hook Events. See hook-events.txt.

Hook* register_hook(Module* owner, char* hook_name)

This API call will create a new hook, named hook_name, and associate it with
the module specified. Successfuly registration results in a pointer to the new
hook. Failure will result in NULL being returned.

Please also read module-api.txt to see how to specify an owner correctly.

End of document.
