X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fovsdb-idl.h;h=e7ae6f1d4daa1c155fda32176a81b8ce4feb95d7;hb=de5cdb90f7c02d22b0595c7dc311c5306291b02f;hp=9179e380eb1bb0f99d1dc2f6a423771548a2ef4c;hpb=c547535a7c25ce4717b965b77877062796f12a95;p=sliver-openvswitch.git

diff --git a/lib/ovsdb-idl.h b/lib/ovsdb-idl.h
index 9179e380e..e7ae6f1d4 100644
--- a/lib/ovsdb-idl.h
+++ b/lib/ovsdb-idl.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2009, 2010 Nicira Networks.
+/* Copyright (c) 2009, 2010, 2011 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -43,19 +43,58 @@ struct ovsdb_idl_table_class;
 struct uuid;
 
 struct ovsdb_idl *ovsdb_idl_create(const char *remote,
-                                   const struct ovsdb_idl_class *);
+                                   const struct ovsdb_idl_class *,
+                                   bool monitor_everything_by_default);
 void ovsdb_idl_destroy(struct ovsdb_idl *);
 
 bool ovsdb_idl_run(struct ovsdb_idl *);
 void ovsdb_idl_wait(struct ovsdb_idl *);
 
+void ovsdb_idl_set_lock(struct ovsdb_idl *, const char *lock_name);
+bool ovsdb_idl_has_lock(const struct ovsdb_idl *);
+bool ovsdb_idl_is_lock_contended(const struct ovsdb_idl *);
+
 unsigned int ovsdb_idl_get_seqno(const struct ovsdb_idl *);
 bool ovsdb_idl_has_ever_connected(const struct ovsdb_idl *);
 void ovsdb_idl_force_reconnect(struct ovsdb_idl *);
+
+/* Choosing columns and tables to replicate. */
+
+/* Modes with which the IDL can monitor a column.
+ *
+ * If no bits are set, the column is not monitored at all.  Its value will
+ * always appear to the client to be the default value for its type.
+ *
+ * If OVSDB_IDL_MONITOR is set, then the column is replicated.  Its value will
+ * reflect the value in the database.  If OVSDB_IDL_ALERT is also set, then
+ * ovsdb_idl_run() will return "true", and the value returned by
+ * ovsdb_idl_get_seqno() will change, when the column's value changes.
+ *
+ * The possible mode combinations are:
+ *
+ *   - 0, for a column that a client doesn't care about.
+ *
+ *   - (OVSDB_IDL_MONITOR | OVSDB_IDL_ALERT), for a column that a client wants
+ *     to track and possibly update.
+ *
+ *   - OVSDB_IDL_MONITOR, for columns that a client treats as "write-only",
+ *     that is, it updates them but doesn't want to get alerted about its own
+ *     updates.  It also won't be alerted about other clients' updates, so this
+ *     is suitable only for use by a client that "owns" a particular column.
+ *
+ *   - OVDSB_IDL_ALERT without OVSDB_IDL_MONITOR is not valid.
+ */
+#define OVSDB_IDL_MONITOR (1 << 0) /* Monitor this column? */
+#define OVSDB_IDL_ALERT   (1 << 1) /* Alert client when column updated? */
+
+void ovsdb_idl_add_column(struct ovsdb_idl *, const struct ovsdb_idl_column *);
+void ovsdb_idl_add_table(struct ovsdb_idl *,
+                         const struct ovsdb_idl_table_class *);
 
-void ovsdb_idl_set_write_only(struct ovsdb_idl *,
-                              const struct ovsdb_idl_column *);
 void ovsdb_idl_omit(struct ovsdb_idl *, const struct ovsdb_idl_column *);
+void ovsdb_idl_omit_alert(struct ovsdb_idl *, const struct ovsdb_idl_column *);
+
+/* Reading the database replica. */
 
 const struct ovsdb_idl_row *ovsdb_idl_get_row_for_uuid(
     const struct ovsdb_idl *, const struct ovsdb_idl_table_class *,
@@ -71,7 +110,12 @@ const struct ovsdb_datum *ovsdb_idl_get(const struct ovsdb_idl_row *,
                                         enum ovsdb_atomic_type key_type,
                                         enum ovsdb_atomic_type value_type);
 
+bool ovsdb_idl_row_is_synthetic(const struct ovsdb_idl_row *);
+
+/* Transactions. */
+
 enum ovsdb_idl_txn_status {
+    TXN_UNCOMMITTED,            /* Not yet committed or aborted. */
     TXN_UNCHANGED,              /* Transaction didn't include any changes. */
     TXN_INCOMPLETE,             /* Commit in progress, please wait. */
     TXN_ABORTED,                /* ovsdb_idl_txn_abort() called. */
@@ -79,6 +123,7 @@ enum ovsdb_idl_txn_status {
     TXN_TRY_AGAIN,              /* Commit failed because a "verify" operation
                                  * reported an inconsistency, due to a network
                                  * problem, or other transient failure. */
+    TXN_NOT_LOCKED,             /* Server hasn't given us the lock yet. */
     TXN_ERROR                   /* Commit failed due to a hard error. */
 };