unbound/pythonmod/pythonmod.h

   1 /*
   2  * pythonmod.h: module header file
   3  *
   4  * Copyright (c) 2009, Zdenek Vasicek (vasicek AT fit.vutbr.cz)
   5  *                     Marek Vavrusa  (xvavru00 AT stud.fit.vutbr.cz)
   6  *
   7  * This software is open source.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  *    * Redistributions of source code must retain the above copyright notice,
  14  *      this list of conditions and the following disclaimer.
  15  *
  16  *    * Redistributions in binary form must reproduce the above copyright notice,
  17  *      this list of conditions and the following disclaimer in the documentation
  18  *      and/or other materials provided with the distribution.
  19  *
  20  *    * Neither the name of the organization nor the names of its
  21  *      contributors may be used to endorse or promote products derived from this
  22  *      software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  26  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  27  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36 /**
  37  * \file
  38  * Python module for unbound.  Calls python script.
  39  */
  40 #ifndef PYTHONMOD_H
  41 #define PYTHONMOD_H
  42 #include "util/module.h"
  43 #include "services/outbound_list.h"
  44
  45 /**
  46  * Get the module function block.
  47  * @return: function block with function pointers to module methods.
  48  */
  49 struct module_func_block* pythonmod_get_funcblock(void);
  50
  51 /** python module init */
  52 int pythonmod_init(struct module_env* env, int id);
  53
  54 /** python module deinit */
  55 void pythonmod_deinit(struct module_env* env, int id);
  56
  57 /** python module operate on a query */
  58 void pythonmod_operate(struct module_qstate* qstate, enum module_ev event, int id, struct outbound_entry* outbound);
  59
  60 /** python module  */
  61 void pythonmod_inform_super(struct module_qstate* qstate, int id, struct module_qstate* super);
  62
  63 /** python module cleanup query state */
  64 void pythonmod_clear(struct module_qstate* qstate, int id);
  65
  66 /** python module alloc size routine */
  67 size_t pythonmod_get_mem(struct module_env* env, int id);
  68 #endif /* PYTHONMOD_H */