chiark - git - mdw - disorder/blob - lib/client.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004-2008 Richard Kettlewell
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/client.h
  19  * @brief Simple C client
  20  *
  21  * See @ref lib/client-stubs.h for the (generated) per-command entry
  22  * points.
  23  *
  24  * See @ref lib/eclient.h for an asynchronous-capable client
  25  * implementation.
  26  */
  27
  28 #ifndef CLIENT_H
  29 #define CLIENT_H
  30
  31 #include <time.h>
  32 #include "configuration.h"
  33
  34 /** @brief Client data */
  35 typedef struct disorder_client disorder_client;
  36
  37 struct queue_entry;
  38 struct kvp;
  39 struct sink;
  40
  41 disorder_client *disorder_new(int verbose);
  42 void disorder_force_unpriv(disorder_client *c);
  43 int disorder_client_af(disorder_client *c);
  44 int disorder_connect(disorder_client *c);
  45 int disorder_connect_user(disorder_client *c,
  46                           const char *username,
  47                           const char *password);
  48 int disorder_connect_cookie(disorder_client *c, const char *cookie);
  49 int disorder_connect_generic(struct config *conf,
  50                              disorder_client *c,
  51                              const char *username,
  52                              const char *password,
  53                              const char *cookie);
  54 int disorder_close(disorder_client *c);
  55 char *disorder_user(disorder_client *c);
  56 int disorder_log(disorder_client *c, struct sink *s);
  57 const char *disorder_last(disorder_client *c);
  58
  59 #include "client-stubs.h"
  60
  61 #endif /* CLIENT_H */
  62
  63 /*
  64 Local Variables:
  65 c-basic-offset:2
  66 comment-column:40
  67 End:
  68 */