unbound/winrc/w_inst.h

   1 /*
   2  * winrc/w_inst.h - install and remove functions
   3  *
   4  * Copyright (c) 2009, 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
  25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /**
  37  * \file
  38  *
  39  * Contains install and remove functions that manipulate the
  40  * windows services API and windows registry.
  41  */
  42
  43 #ifndef WINRC_W_INST_H
  44 #define WINRC_W_INST_H
  45
  46 /**
  47  * Install service in servicecontrolmanager, setup registry
  48  * @param out: debug output printed here (errors). or NULL.
  49  * @param rename: if nonNULL this executable is not unbound.exe but this name.
  50  */
  51 void wsvc_install(FILE* out, const char* rename);
  52
  53 /**
  54  * Remove installed service from servicecontrolmanager, registry entries
  55  * @param out: debug output printed here (errors). or NULL.
  56  */
  57 void wsvc_remove(FILE* out);
  58
  59 /**
  60  * Start the service from servicecontrolmanager, tells OS to start daemon.
  61  * @param out: debug output printed here (errors). or NULL.
  62  */
  63 void wsvc_rc_start(FILE* out);
  64
  65 /**
  66  * Stop the service from servicecontrolmanager, tells OS to stop daemon.
  67  * @param out: debug output printed here (errors). or NULL.
  68  */
  69 void wsvc_rc_stop(FILE* out);
  70
  71 /**
  72  * Convert windows GetLastError() value to a neat string.
  73  * @param str: destination buffer
  74  * @param len: length of dest buffer
  75  * @param fixed: fixed text to prepend to string.
  76  * @param err: the GetLastError() value.
  77  */
  78 void wsvc_err2str(char* str, size_t len, const char* fixed, DWORD err);
  79
  80 #endif /* WINRC_W_INST_H */