ovsdb/ovsdb-util.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   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_UTIL_H
  17 #define OVSDB_UTIL_H 1
  18
  19 /* Database access utility functions. */
  20 struct ovsdb_datum *ovsdb_util_get_datum(struct ovsdb_row *row,
  21                                          const char *column_name,
  22                                          const enum ovsdb_atomic_type keytype,
  23                                          const enum ovsdb_atomic_type valtype,
  24                                          const size_t n_max);
  25 const char *ovsdb_util_read_map_string_column(const struct ovsdb_row *row,
  26                                               const char *column_name,
  27                                               const char *key);
  28 const struct ovsdb_row *ovsdb_util_read_map_string_uuid_column(
  29                                                     const struct ovsdb_row *r,
  30                                                     const char *column_name,
  31                                                     const char *key);
  32 const union ovsdb_atom *ovsdb_util_read_column(const struct ovsdb_row *row,
  33                                                const char *column_name,
  34                                                enum ovsdb_atomic_type type);
  35 bool ovsdb_util_read_integer_column(const struct ovsdb_row *row,
  36                                     const char *column_name,
  37                                     long long int *integerp);
  38 bool ovsdb_util_read_string_column(const struct ovsdb_row *row,
  39                                    const char *column_name,
  40                                    const char **stringp);
  41 void ovsdb_util_write_string_string_column(struct ovsdb_row *row,
  42                                            const char *column_name,
  43                                            char **keys, char **values,
  44                                            size_t n);
  45 bool ovsdb_util_read_bool_column(const struct ovsdb_row *row,
  46                                  const char *column_name,
  47                                  bool *boolp);
  48 void ovsdb_util_write_bool_column(struct ovsdb_row *row,
  49                                   const char *column_name,
  50                                   bool value);
  51
  52 #endif /* ovsdb/util.h */