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.
34 #ifndef VCONN_PROVIDER_H
35 #define VCONN_PROVIDER_H 1
37 /* Provider interface, which provide a virtual connection to an OpenFlow
42 /* Virtual connection to an OpenFlow device. */
44 struct vconn_class *class;
50 void vconn_init(struct vconn *, struct vconn_class *, int connect_status,
51 uint32_t ip, const char *name);
54 /* Prefix for connection names, e.g. "nl", "tcp". */
57 /* Attempts to connect to an OpenFlow device. 'name' is the full
58 * connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4". This
59 * name is useful for error messages but must not be modified.
61 * 'suffix' is a copy of 'name' following the colon and may be modified.
63 * Returns 0 if successful, otherwise a positive errno value. If
64 * successful, stores a pointer to the new connection in '*vconnp'.
66 * The open function must not block waiting for a connection to complete.
67 * If the connection cannot be completed immediately, it should return
68 * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
69 * continue the connection in the background. */
70 int (*open)(const char *name, char *suffix, struct vconn **vconnp);
72 /* Closes 'vconn' and frees associated memory. */
73 void (*close)(struct vconn *vconn);
75 /* Tries to complete the connection on 'vconn', which must be an active
76 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
77 * was successful or a positive errno value if it failed. If the
78 * connection is still in progress, returns EAGAIN.
80 * The connect function must not block waiting for the connection to
81 * complete; instead, it should return EAGAIN immediately. */
82 int (*connect)(struct vconn *vconn);
84 /* Tries to accept a new connection on 'vconn', which must be a passive
85 * vconn. If successful, stores the new connection in '*new_vconnp' and
86 * returns 0. Otherwise, returns a positive errno value.
88 * The accept function must not block waiting for a connection. If no
89 * connection is ready to be accepted, it should return EAGAIN.
91 * Nonnull iff this is a passive vconn (one that accepts connections and
92 * does not transfer data). */
93 int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
95 /* Tries to receive an OpenFlow message from 'vconn', which must be an
96 * active vconn. If successful, stores the received message into '*msgp'
97 * and returns 0. The caller is responsible for destroying the message
98 * with ofpbuf_delete(). On failure, returns a positive errno value and
99 * stores a null pointer into '*msgp'.
101 * If the connection has been closed in the normal fashion, returns EOF.
103 * The recv function must not block waiting for a packet to arrive. If no
104 * packets have been received, it should return EAGAIN.
106 * Nonnull iff this is an active vconn (one that transfers data and does
107 * not accept connections). */
108 int (*recv)(struct vconn *vconn, struct ofpbuf **msgp);
110 /* Tries to queue 'msg' for transmission on 'vconn', which must be an
111 * active vconn. If successful, returns 0, in which case ownership of
112 * 'msg' is transferred to the vconn. Success does not guarantee that
113 * 'msg' has been or ever will be delivered to the peer, only that it has
114 * been queued for transmission.
116 * Returns a positive errno value on failure, in which case the caller
117 * retains ownership of 'msg'.
119 * The send function must not block. If 'msg' cannot be immediately
120 * accepted for transmission, it should return EAGAIN.
122 * Nonnull iff this is an active vconn (one that transfers data and does
123 * not accept connections). */
124 int (*send)(struct vconn *vconn, struct ofpbuf *msg);
126 void (*wait)(struct vconn *vconn, enum vconn_wait_type);
129 #endif /* vconn-provider.h */