2 * Copyright (c) 2015 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef OVSDB_MONITOR_H
18 #define OVSDB_MONITOR_H
22 enum ovsdb_monitor_selection {
23 OJMS_INITIAL = 1 << 0, /* All rows when monitor is created. */
24 OJMS_INSERT = 1 << 1, /* New rows. */
25 OJMS_DELETE = 1 << 2, /* Deleted rows. */
26 OJMS_MODIFY = 1 << 3 /* Modified rows. */
30 enum ovsdb_monitor_version {
31 OVSDB_MONITOR_V1, /* RFC 7047 "monitor" method. */
32 OVSDB_MONITOR_V2, /* Extension to RFC 7047, see ovsdb-server
33 man page for details. */
36 OVSDB_MONITOR_VERSION_MAX
39 struct ovsdb_monitor *ovsdb_monitor_create(struct ovsdb *db,
40 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
42 struct ovsdb_monitor *ovsdb_monitor_add(struct ovsdb_monitor *dbmon);
44 void ovsdb_monitor_add_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
45 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
47 void ovsdb_monitor_remove_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
48 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
50 void ovsdb_monitor_remove_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
51 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
53 void ovsdb_monitor_add_table(struct ovsdb_monitor *m,
54 const struct ovsdb_table *table);
56 void ovsdb_monitor_add_column(struct ovsdb_monitor *dbmon,
57 const struct ovsdb_table *table,
58 const struct ovsdb_column *column,
59 enum ovsdb_monitor_selection select,
60 size_t *allocated_columns);
62 const char * OVS_WARN_UNUSED_RESULT
63 ovsdb_monitor_table_check_duplicates(struct ovsdb_monitor *,
64 const struct ovsdb_table *);
66 struct json *ovsdb_monitor_get_update(struct ovsdb_monitor *dbmon,
68 uint64_t *unflushed_transaction,
69 enum ovsdb_monitor_version version);
71 void ovsdb_monitor_table_add_select(struct ovsdb_monitor *dbmon,
72 const struct ovsdb_table *table,
73 enum ovsdb_monitor_selection select);
75 bool ovsdb_monitor_needs_flush(struct ovsdb_monitor *dbmon,
76 uint64_t next_transaction);
78 void ovsdb_monitor_get_initial(const struct ovsdb_monitor *dbmon);