[ovs.git] / ovsdb / ovsdb.h

/* Copyright (c) 2009, 2010 Nicira Networks
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef OVSDB_OVSDB_H
#define OVSDB_OVSDB_H 1

#include "compiler.h"
#include "hmap.h"
#include "list.h"
#include "shash.h"

struct json;
struct ovsdb_log;
struct ovsdb_txn;
struct uuid;

/* Database schema. */
struct ovsdb_schema {
    char *name;
    struct shash tables;        /* Contains "struct ovsdb_table_schema *"s. */
};

struct ovsdb_schema *ovsdb_schema_create(const char *name);
struct ovsdb_schema *ovsdb_schema_clone(const struct ovsdb_schema *);
void ovsdb_schema_destroy(struct ovsdb_schema *);

struct ovsdb_error *ovsdb_schema_from_file(const char *file_name,
                                           struct ovsdb_schema **)
    WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_schema_from_json(struct json *,
                                           struct ovsdb_schema **)
    WARN_UNUSED_RESULT;
struct json *ovsdb_schema_to_json(const struct ovsdb_schema *);
\f
/* Database. */
struct ovsdb {
    struct ovsdb_schema *schema;
    struct list replicas;       /* Contains "struct ovsdb_replica"s. */
    struct shash tables;        /* Contains "struct ovsdb_table *"s. */

    /* Triggers. */
    struct list triggers;       /* Contains "struct ovsdb_trigger"s. */
    bool run_triggers;
};

struct ovsdb *ovsdb_create(struct ovsdb_schema *);
void ovsdb_destroy(struct ovsdb *);

struct ovsdb_error *ovsdb_from_json(const struct json *, struct ovsdb **)
    WARN_UNUSED_RESULT;
struct json *ovsdb_to_json(const struct ovsdb *);

struct ovsdb_table *ovsdb_get_table(const struct ovsdb *, const char *);

struct json *ovsdb_execute(struct ovsdb *, const struct json *params,
                           long long int elapsed_msec,
                           long long int *timeout_msec);
\f
/* Database replication. */

struct ovsdb_replica {
    struct list node;           /* Element in "struct ovsdb" replicas list. */
    const struct ovsdb_replica_class *class;
};

struct ovsdb_replica_class {
    struct ovsdb_error *(*commit)(struct ovsdb_replica *,
                                  const struct ovsdb_txn *, bool durable);
    void (*destroy)(struct ovsdb_replica *);
};

void ovsdb_replica_init(struct ovsdb_replica *,
                        const struct ovsdb_replica_class *);

void ovsdb_add_replica(struct ovsdb *, struct ovsdb_replica *);
void ovsdb_remove_replica(struct ovsdb *, struct ovsdb_replica *);

#endif /* ovsdb/ovsdb.h */
Commit	Line	Data
58985e09	1	/* Copyright (c) 2009, 2010 Nicira Networks
f85f8ebb BP	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_OVSDB_H
	17	#define OVSDB_OVSDB_H 1
	18
	19	#include "compiler.h"
	20	#include "hmap.h"
	21	#include "list.h"
	22	#include "shash.h"
	23
	24	struct json;
bd06962a BP	25	struct ovsdb_log;
bd06962a BP	26	struct ovsdb_txn;
f85f8ebb BP	27	struct uuid;
	28
	29	/* Database schema. */
	30	struct ovsdb_schema {
	31	char *name;
f85f8ebb BP	32	struct shash tables; /* Contains "struct ovsdb_table_schema "s. /
	33	};
	34
2e57b537	35	struct ovsdb_schema ovsdb_schema_create(const char name);
58985e09	36	struct ovsdb_schema ovsdb_schema_clone(const struct ovsdb_schema );
f85f8ebb BP	37	void ovsdb_schema_destroy(struct ovsdb_schema *);
	38
	39	struct ovsdb_error ovsdb_schema_from_file(const char file_name,
	40	struct ovsdb_schema **)
	41	WARN_UNUSED_RESULT;
	42	struct ovsdb_error ovsdb_schema_from_json(struct json ,
	43	struct ovsdb_schema **)
	44	WARN_UNUSED_RESULT;
	45	struct json ovsdb_schema_to_json(const struct ovsdb_schema );
	46	\f
	47	/* Database. */
	48	struct ovsdb {
	49	struct ovsdb_schema *schema;
bd06962a	50	struct list replicas; /* Contains "struct ovsdb_replica"s. */
f85f8ebb BP	51	struct shash tables; /* Contains "struct ovsdb_table "s. /
	52
	53	/* Triggers. */
	54	struct list triggers; /* Contains "struct ovsdb_trigger"s. */
	55	bool run_triggers;
	56	};
	57
bd06962a	58	struct ovsdb ovsdb_create(struct ovsdb_schema );
f85f8ebb BP	59	void ovsdb_destroy(struct ovsdb *);
	60
	61	struct ovsdb_error ovsdb_from_json(const struct json , struct ovsdb **)
	62	WARN_UNUSED_RESULT;
	63	struct json ovsdb_to_json(const struct ovsdb );
	64
	65	struct ovsdb_table ovsdb_get_table(const struct ovsdb , const char *);
	66
	67	struct json ovsdb_execute(struct ovsdb , const struct json *params,
	68	long long int elapsed_msec,
	69	long long int *timeout_msec);
bd06962a BP	70	\f
	71	/* Database replication. */
	72
	73	struct ovsdb_replica {
	74	struct list node; /* Element in "struct ovsdb" replicas list. */
	75	const struct ovsdb_replica_class *class;
	76	};
	77
	78	struct ovsdb_replica_class {
	79	struct ovsdb_error (commit)(struct ovsdb_replica *,
	80	const struct ovsdb_txn *, bool durable);
	81	void (destroy)(struct ovsdb_replica );
	82	};
	83
	84	void ovsdb_replica_init(struct ovsdb_replica *,
	85	const struct ovsdb_replica_class *);
	86
	87	void ovsdb_add_replica(struct ovsdb , struct ovsdb_replica );
	88	void ovsdb_remove_replica(struct ovsdb , struct ovsdb_replica );
f85f8ebb BP	89
f85f8ebb BP	90	#endif /* ovsdb/ovsdb.h */