lib/unixctl.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2011 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef UNIXCTL_H
  18 #define UNIXCTL_H 1
  19
  20 #ifdef  __cplusplus
  21 extern "C" {
  22 #endif
  23
  24 /* Server for Unix domain socket control connection. */
  25 struct unixctl_server;
  26 int unixctl_server_create(const char *path, struct unixctl_server **);
  27 void unixctl_server_run(struct unixctl_server *);
  28 void unixctl_server_wait(struct unixctl_server *);
  29 void unixctl_server_destroy(struct unixctl_server *);
  30
  31 const char *unixctl_server_get_path(const struct unixctl_server *);
  32
  33 /* Client for Unix domain socket control connection. */
  34 struct jsonrpc;
  35 int unixctl_client_create(const char *path, struct jsonrpc **client);
  36 int unixctl_client_transact(struct jsonrpc *client,
  37                             const char *command,
  38                             int argc, char *argv[],
  39                             char **result, char **error);
  40
  41 /* Command registration. */
  42 struct unixctl_conn;
  43 typedef void unixctl_cb_func(struct unixctl_conn *,
  44                              int argc, const char *argv[], void *aux);
  45 void unixctl_command_register(const char *name, const char *usage,
  46                               int min_args, int max_args,
  47                               unixctl_cb_func *cb, void *aux);
  48 void unixctl_command_reply_error(struct unixctl_conn *, const char *error);
  49 void unixctl_command_reply(struct unixctl_conn *, const char *body);
  50
  51 #ifdef  __cplusplus
  52 }
  53 #endif
  54
  55 #endif /* unixctl.h */