diff options
| author | Ben Pfaff <blp@nicira.com> | 2010-06-23 10:13:39 -0700 |
|---|---|---|
| committer | Ben Pfaff <blp@nicira.com> | 2010-06-23 12:43:02 -0700 |
| commit | 2ce42c885a07e9de427e53901f6a46a2b8504fd7 (patch) | |
| tree | fcde3c1d87358dc94c8533f378b5fe2a1916fdb6 /lib/ovsdb-idl.h | |
| parent | 4ea21243f5a6002528d33d2bd58ce41a9d03a4c4 (diff) | |
ovsdb-idl: Start documenting the public interface.
Long overdue.
Diffstat (limited to 'lib/ovsdb-idl.h')
| -rw-r--r-- | lib/ovsdb-idl.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/ovsdb-idl.h b/lib/ovsdb-idl.h index 88bd7b3a..7832e4ee 100644 --- a/lib/ovsdb-idl.h +++ b/lib/ovsdb-idl.h @@ -16,6 +16,20 @@ #ifndef OVSDB_IDL_H #define OVSDB_IDL_H 1 +/* Open vSwitch Database Interface Definition Language (OVSDB IDL). + * + * The OVSDB IDL maintains an in-memory replica of a database. It issues RPC + * requests to an OVSDB database server and parses the responses, converting + * raw JSON into data structures that are easier for clients to digest. Most + * notably, references to rows via UUID become C pointers. + * + * The IDL also assists with issuing database transactions. The client creates + * a transaction, manipulates the IDL data structures, and commits or aborts + * the transaction. The IDL then composes and issues the necessary JSON-RPC + * requests and reports to the client whether the transaction completed + * successfully. + */ + #include <stdbool.h> #include <stdint.h> #include "compiler.h" |