lib/ovsdb-idl.h

   1 /* Copyright (c) 2009, 2010 Nicira Networks.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef OVSDB_IDL_H
  17 #define OVSDB_IDL_H 1
  18
  19 #include <stdbool.h>
  20 #include <stdint.h>
  21
  22 struct json;
  23 struct ovsdb_datum;
  24 struct ovsdb_idl_class;
  25 struct ovsdb_idl_column;
  26 struct ovsdb_idl_table_class;
  27 struct uuid;
  28
  29 struct ovsdb_idl *ovsdb_idl_create(const char *remote,
  30                                    const struct ovsdb_idl_class *);
  31 void ovsdb_idl_destroy(struct ovsdb_idl *);
  32
  33 void ovsdb_idl_run(struct ovsdb_idl *);
  34 void ovsdb_idl_wait(struct ovsdb_idl *);
  35
  36 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *);
  37 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *);
  38 void ovsdb_idl_force_reconnect(struct ovsdb_idl *);
  39
  40 const struct ovsdb_idl_row *ovsdb_idl_get_row_for_uuid(
  41     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *,
  42     const struct uuid *);
  43 const struct ovsdb_idl_row *ovsdb_idl_first_row(
  44     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *);
  45 const struct ovsdb_idl_row *ovsdb_idl_next_row(const struct ovsdb_idl_row *);
  46
  47 enum ovsdb_idl_txn_status {
  48     TXN_UNCHANGED,              /* Transaction didn't include any changes. */
  49     TXN_INCOMPLETE,             /* Commit in progress, please wait. */
  50     TXN_ABORTED,                /* ovsdb_idl_txn_abort() called. */
  51     TXN_SUCCESS,                /* Commit successful. */
  52     TXN_TRY_AGAIN,              /* Commit failed because a "verify" operation
  53                                  * reported an inconsistency, due to a network
  54                                  * problem, or other transient failure. */
  55     TXN_ERROR                   /* Commit failed due to a hard error. */
  56 };
  57
  58 const char *ovsdb_idl_txn_status_to_string(enum ovsdb_idl_txn_status);
  59
  60 struct ovsdb_idl_txn *ovsdb_idl_txn_create(struct ovsdb_idl *);
  61 void ovsdb_idl_txn_add_comment(struct ovsdb_idl_txn *, const char *);
  62 void ovsdb_idl_txn_set_dry_run(struct ovsdb_idl_txn *);
  63 void ovsdb_idl_txn_increment(struct ovsdb_idl_txn *, const char *table,
  64                              const char *column, const struct json *where);
  65 void ovsdb_idl_txn_destroy(struct ovsdb_idl_txn *);
  66 void ovsdb_idl_txn_wait(const struct ovsdb_idl_txn *);
  67 enum ovsdb_idl_txn_status ovsdb_idl_txn_commit(struct ovsdb_idl_txn *);
  68 void ovsdb_idl_txn_abort(struct ovsdb_idl_txn *);
  69
  70 int64_t ovsdb_idl_txn_get_increment_new_value(const struct ovsdb_idl_txn *);
  71 const struct uuid *ovsdb_idl_txn_get_insert_uuid(const struct ovsdb_idl_txn *,
  72                                                  const struct uuid *);
  73
  74 void ovsdb_idl_txn_read(const struct ovsdb_idl_row *,
  75                         const struct ovsdb_idl_column *,
  76                         struct ovsdb_datum *);
  77 void ovsdb_idl_txn_write(const struct ovsdb_idl_row *,
  78                          const struct ovsdb_idl_column *,
  79                          struct ovsdb_datum *);
  80 void ovsdb_idl_txn_delete(const struct ovsdb_idl_row *);
  81 const struct ovsdb_idl_row *ovsdb_idl_txn_insert(
  82     struct ovsdb_idl_txn *, const struct ovsdb_idl_table_class *);
  83
  84 #endif /* ovsdb-idl.h */