include/yaz/sc.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /** \file sc.h
  29     \brief Header for Windows Service Control utility
  30
  31     This is a simple wrapper for the Windows Service Control system. It
  32     also operates on Unix in which case the user supplied main function
  33     (sc_main) is is called immediately. See sc_test.c for an example.
  34  */
  35
  36 #include <yaz/yconfig.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 /** service control handle (opaque type) */
  41 typedef struct sc_s *yaz_sc_t;
  42
  43 /** \brief creates service handle
  44     \param service_name Service Name
  45     \param display_name Display Name
  46     \return service control handle
  47
  48     This function does not activate the service. Only creates handle.
  49 */
  50 YAZ_EXPORT yaz_sc_t yaz_sc_create(const char *service_name,
  51                                   const char *display_name);
  52
  53 /** \brief registers service controlled program
  54     \param s service control handle
  55     \param argc argc as given from main
  56     \param argv argv as given from main
  57     \param sc_main service main function
  58     \param sc_stop service stop function
  59     \return sc_main return value
  60
  61     sc_main is the main program of the application. It should initialize
  62     the application.. Function yaz_sc_running MUST be called before
  63     the application operates (after initialization)
  64 */
  65 YAZ_EXPORT int yaz_sc_program(yaz_sc_t s, int argc, char **argv,
  66                               int (*sc_main)(yaz_sc_t s, int argc, char **argv),
  67                               void (*sc_stop)(yaz_sc_t s));
  68
  69 /** \brief signals that sc_main applicatio starts running
  70     \param s service control handle
  71 */
  72 YAZ_EXPORT void yaz_sc_running(yaz_sc_t s);
  73
  74 /** \brief frees service control handle
  75     \param s service control handle
  76 */
  77 YAZ_EXPORT void yaz_sc_destroy(yaz_sc_t *s);
  78
  79 YAZ_END_CDECL
  80
  81 /*
  82  * Local variables:
  83  * c-basic-offset: 4
  84  * c-file-style: "Stroustrup"
  85  * indent-tabs-mode: nil
  86  * End:
  87  * vim: shiftwidth=4 tabstop=8 expandtab
  88  */
  89