bridge: Deprecate the null interface type.
[sliver-openvswitch.git] / lib / vconn.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef VCONN_H
18 #define VCONN_H 1
19
20 #include <stdbool.h>
21 #include "openvswitch/types.h"
22 #include "openflow/openflow.h"
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 struct list;
29 struct ofpbuf;
30 struct pvconn;
31 struct vconn;
32
33 void vconn_usage(bool active, bool passive, bool bootstrap);
34
35 /* Active vconns: virtual connections to OpenFlow devices. */
36 int vconn_verify_name(const char *name);
37 int vconn_open(const char *name, int min_version,
38                struct vconn **, uint8_t dscp);
39 void vconn_close(struct vconn *);
40 const char *vconn_get_name(const struct vconn *);
41 ovs_be32 vconn_get_remote_ip(const struct vconn *);
42 ovs_be16 vconn_get_remote_port(const struct vconn *);
43 ovs_be32 vconn_get_local_ip(const struct vconn *);
44 ovs_be16 vconn_get_local_port(const struct vconn *);
45 int vconn_get_version(const struct vconn *);
46 int vconn_connect(struct vconn *);
47 int vconn_recv(struct vconn *, struct ofpbuf **);
48 int vconn_send(struct vconn *, struct ofpbuf *);
49 int vconn_recv_xid(struct vconn *, ovs_be32 xid, struct ofpbuf **);
50 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
51 int vconn_transact_noreply(struct vconn *, struct ofpbuf *, struct ofpbuf **);
52 int vconn_transact_multiple_noreply(struct vconn *, struct list *requests,
53                                     struct ofpbuf **replyp);
54
55 void vconn_run(struct vconn *);
56 void vconn_run_wait(struct vconn *);
57
58 int vconn_open_block(const char *name, enum ofp_version min_version,
59                      struct vconn **);
60 int vconn_connect_block(struct vconn *);
61 int vconn_send_block(struct vconn *, struct ofpbuf *);
62 int vconn_recv_block(struct vconn *, struct ofpbuf **);
63
64 enum vconn_wait_type {
65     WAIT_CONNECT,
66     WAIT_RECV,
67     WAIT_SEND
68 };
69 void vconn_wait(struct vconn *, enum vconn_wait_type);
70 void vconn_connect_wait(struct vconn *);
71 void vconn_recv_wait(struct vconn *);
72 void vconn_send_wait(struct vconn *);
73
74 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
75 int pvconn_verify_name(const char *name);
76 int pvconn_open(const char *name, struct pvconn **, uint8_t dscp);
77 const char *pvconn_get_name(const struct pvconn *);
78 void pvconn_close(struct pvconn *);
79 int pvconn_accept(struct pvconn *, int min_version, struct vconn **);
80 void pvconn_wait(struct pvconn *);
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* vconn.h */