1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
47 /* Client interface to vconns, which provide a virtual connection to an
50 void vconn_usage(bool active, bool passive);
51 int vconn_open(const char *name, struct vconn **);
52 void vconn_close(struct vconn *);
53 bool vconn_is_passive(const struct vconn *);
54 uint32_t vconn_get_ip(const struct vconn *);
55 int vconn_connect(struct vconn *);
56 int vconn_accept(struct vconn *, struct vconn **);
57 int vconn_recv(struct vconn *, struct ofpbuf **);
58 int vconn_send(struct vconn *, struct ofpbuf *);
59 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
61 int vconn_open_block(const char *name, struct vconn **);
62 int vconn_send_block(struct vconn *, struct ofpbuf *);
63 int vconn_recv_block(struct vconn *, struct ofpbuf **);
65 enum vconn_wait_type {
71 void vconn_wait(struct vconn *, enum vconn_wait_type);
72 void vconn_connect_wait(struct vconn *);
73 void vconn_accept_wait(struct vconn *);
74 void vconn_recv_wait(struct vconn *);
75 void vconn_send_wait(struct vconn *);
77 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
78 void *make_openflow_xid(size_t openflow_len, uint8_t type,
79 uint32_t xid, struct ofpbuf **);
80 void update_openflow_length(struct ofpbuf *);
81 struct ofpbuf *make_add_flow(const struct flow *, uint32_t buffer_id,
82 uint16_t max_idle, size_t n_actions);
83 struct ofpbuf *make_add_simple_flow(const struct flow *,
84 uint32_t buffer_id, uint16_t out_port,
86 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
87 uint16_t in_port, uint16_t out_port);
88 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
89 uint16_t in_port, uint16_t out_port);
90 struct ofpbuf *make_echo_request(void);
91 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
93 extern struct vconn_class tcp_vconn_class;
94 extern struct vconn_class ptcp_vconn_class;
95 extern struct vconn_class unix_vconn_class;
96 extern struct vconn_class punix_vconn_class;
98 extern struct vconn_class ssl_vconn_class;
99 extern struct vconn_class pssl_vconn_class;
102 extern struct vconn_class netlink_vconn_class;