summaryrefslogtreecommitdiff
path: root/ovsdb/log.h
blob: b9773c7073d8fe257ba0de66cffce5fb601e1db1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/* Copyright (c) 2009, 2010, 2011, 2016 Nicira, Inc.
 *
 * 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_LOG_H
#define OVSDB_LOG_H 1

#include <sys/types.h>
#include "compiler.h"

struct json;
struct ovsdb_log;

/* Access mode for opening an OVSDB log. */
enum ovsdb_log_open_mode {
    OVSDB_LOG_READ_ONLY,        /* Open existing file, read-only. */
    OVSDB_LOG_READ_WRITE,       /* Open existing file, read/write. */
    OVSDB_LOG_CREATE_EXCL,      /* Create new file, read/write. */
    OVSDB_LOG_CREATE            /* Create or open file, read/write. */
};

#define OVSDB_MAGIC "OVSDB JSON"

struct ovsdb_error *ovsdb_log_open(const char *name, const char *magic,
                                   enum ovsdb_log_open_mode,
                                   int locking, struct ovsdb_log **)
    OVS_WARN_UNUSED_RESULT;
void ovsdb_log_close(struct ovsdb_log *);

struct ovsdb_error *ovsdb_log_read(struct ovsdb_log *, char **)
    OVS_WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_log_read_json(struct ovsdb_log *, struct json **)
    OVS_WARN_UNUSED_RESULT;
void ovsdb_log_unread(struct ovsdb_log *);

struct ovsdb_error *ovsdb_log_write(struct ovsdb_log *, const char *)
    OVS_WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_log_write_json(struct ovsdb_log *,
                                         const struct json *)
    OVS_WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_log_commit(struct ovsdb_log *)
    OVS_WARN_UNUSED_RESULT;

struct ovsdb_error *ovsdb_log_truncate(struct ovsdb_log *)
    OVS_WARN_UNUSED_RESULT;

off_t ovsdb_log_get_offset(const struct ovsdb_log *);

#endif /* ovsdb/log.h */