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
21 struct ovsdb_jsonrpc_monitor;
22 struct ovsdb_monitor_session_condition;
23 struct ovsdb_condition;
25 enum ovsdb_monitor_selection {
26 OJMS_NONE = 0, /* None for this iteration */
27 OJMS_INITIAL = 1 << 0, /* All rows when monitor is created. */
28 OJMS_INSERT = 1 << 1, /* New rows. */
29 OJMS_DELETE = 1 << 2, /* Deleted rows. */
30 OJMS_MODIFY = 1 << 3 /* Modified rows. */
34 enum ovsdb_monitor_version {
35 OVSDB_MONITOR_V1, /* RFC 7047 "monitor" method. */
36 OVSDB_MONITOR_V2, /* Extension to RFC 7047, see ovsdb-server
37 man page for details. */
40 OVSDB_MONITOR_VERSION_MAX
43 struct ovsdb_monitor *ovsdb_monitor_create(struct ovsdb *db,
44 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
46 struct ovsdb_monitor *ovsdb_monitor_add(struct ovsdb_monitor *dbmon);
48 void ovsdb_monitor_add_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
49 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor);
51 void ovsdb_monitor_remove_jsonrpc_monitor(struct ovsdb_monitor *dbmon,
52 struct ovsdb_jsonrpc_monitor *jsonrpc_monitor,
55 void ovsdb_monitor_add_table(struct ovsdb_monitor *m,
56 const struct ovsdb_table *table);
58 const char * ovsdb_monitor_add_column(struct ovsdb_monitor *dbmon,
59 const struct ovsdb_table *table,
60 const struct ovsdb_column *column,
61 enum ovsdb_monitor_selection select,
64 struct json *ovsdb_monitor_get_update(
65 struct ovsdb_monitor *dbmon,
67 uint64_t *unflushed_transaction,
68 const struct ovsdb_monitor_session_condition *condition,
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);
80 void ovsdb_monitor_get_memory_usage(struct simap *usage);
82 struct ovsdb_monitor_session_condition *
83 ovsdb_monitor_session_condition_create(void);
86 ovsdb_monitor_session_condition_destroy(
87 struct ovsdb_monitor_session_condition *condition);
89 ovsdb_monitor_table_condition_create(
90 struct ovsdb_monitor_session_condition *condition,
91 const struct ovsdb_table *table,
92 const struct json *json_cnd);
95 ovsdb_monitor_condition_bind(struct ovsdb_monitor *dbmon,
96 struct ovsdb_monitor_session_condition *cond);