testcode/fake_event.h

   1 /*
   2  * testcode/fake_event.h - fake event handling that replays existing scenario.
   3  *
   4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
   5  *
   6  * This software is open source.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * Neither the name of the NLNET LABS nor the names of its contributors may
  20  * be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /**
  37  * \file
  38  * Event service that replays a scenario.
  39  * This implements the same exported symbols as the files:
  40  * util/netevent.c
  41  * services/listen_dnsport.c
  42  * services/outside_network.c
  43  * But these do not actually access the network or events, instead
  44  * the scenario is played.
  45  */
  46
  47 #ifndef TESTCODE_FAKE_EVENT_H
  48 #define TESTCODE_FAKE_EVENT_H
  49 struct replay_scenario;
  50
  51 /**
  52  * Initialise fake event services.
  53  *
  54  * The fake event services will automatically start when the main program
  55  * calls netevent.h functions, such as comm_base_dispatch().
  56  *
  57  * @param scen: Set the scenario to use for upcoming event handling.
  58  */
  59 void fake_event_init(struct replay_scenario* scen);
  60
  61 /**
  62  * Deinit fake event services.
  63  */
  64 void fake_event_cleanup(void);
  65
  66 /**
  67  * Get filename to store temporary config stuff. The pid is added. in /tmp.
  68  * @param adj: adjective, like "_cfg_", "_auto_"
  69  * @param id: identifier, like "example.com".
  70  * @param buf: where to store.
  71  * @param len: length of buf.
  72  */
  73 void fake_temp_file(const char* adj, const char* id, char* buf, size_t len);
  74
  75 #endif /* TESTCODE_FAKE_EVENT_H */