#ifndef VCONN_PROVIDER_H
#define VCONN_PROVIDER_H 1
-/* Provider interface, which provide a virtual connection to an OpenFlow
- * device. */
+/* Provider interface to vconns, which provide a virtual connection to an
+ * OpenFlow device. */
#include <assert.h>
#include "vconn.h"
-
-/* Virtual connection to an OpenFlow device.
+\f
+/* Active virtual connection to an OpenFlow device.
*
* This structure should be treated as opaque by vconn implementations. */
struct vconn {
/* Closes 'vconn' and frees associated memory. */
void (*close)(struct vconn *vconn);
- /* Tries to complete the connection on 'vconn', which must be an active
- * vconn. If 'vconn''s connection is complete, returns 0 if the connection
- * was successful or a positive errno value if it failed. If the
- * connection is still in progress, returns EAGAIN.
+ /* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
+ * complete, returns 0 if the connection was successful or a positive errno
+ * value if it failed. If the connection is still in progress, returns
+ * EAGAIN.
*
* The connect function must not block waiting for the connection to
* complete; instead, it should return EAGAIN immediately. */
int (*connect)(struct vconn *vconn);
- /* Tries to accept a new connection on 'vconn', which must be a passive
- * vconn. If successful, stores the new connection in '*new_vconnp' and
- * returns 0. Otherwise, returns a positive errno value.
- *
- * The accept function must not block waiting for a connection. If no
- * connection is ready to be accepted, it should return EAGAIN.
- *
- * Nonnull iff this is a passive vconn (one that accepts connections and
- * does not transfer data). */
- int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
-
- /* Tries to receive an OpenFlow message from 'vconn', which must be an
- * active vconn. If successful, stores the received message into '*msgp'
- * and returns 0. The caller is responsible for destroying the message
- * with buffer_delete(). On failure, returns a positive errno value and
- * stores a null pointer into '*msgp'.
+ /* Tries to receive an OpenFlow message from 'vconn'. If successful,
+ * stores the received message into '*msgp' and returns 0. The caller is
+ * responsible for destroying the message with buffer_delete(). On
+ * failure, returns a positive errno value and stores a null pointer into
+ * '*msgp'.
*
* If the connection has been closed in the normal fashion, returns EOF.
*
* The recv function must not block waiting for a packet to arrive. If no
- * packets have been received, it should return EAGAIN.
- *
- * Nonnull iff this is an active vconn (one that transfers data and does
- * not accept connections). */
+ * packets have been received, it should return EAGAIN. */
int (*recv)(struct vconn *vconn, struct buffer **msgp);
- /* Tries to queue 'msg' for transmission on 'vconn', which must be an
- * active vconn. If successful, returns 0, in which case ownership of
- * 'msg' is transferred to the vconn. Success does not guarantee that
- * 'msg' has been or ever will be delivered to the peer, only that it has
- * been queued for transmission.
+ /* Tries to queue 'msg' for transmission on 'vconn'. If successful,
+ * returns 0, in which case ownership of 'msg' is transferred to the vconn.
+ * Success does not guarantee that 'msg' has been or ever will be delivered
+ * to the peer, only that it has been queued for transmission.
*
* Returns a positive errno value on failure, in which case the caller
* retains ownership of 'msg'.
*
* The send function must not block. If 'msg' cannot be immediately
- * accepted for transmission, it should return EAGAIN.
- *
- * Nonnull iff this is an active vconn (one that transfers data and does
- * not accept connections). */
+ * accepted for transmission, it should return EAGAIN. */
int (*send)(struct vconn *vconn, struct buffer *msg);
- void (*wait)(struct vconn *vconn, enum vconn_wait_type);
+ /* Arranges for the poll loop to wake up when 'vconn' is ready to take an
+ * action of the given 'type'. */
+ void (*wait)(struct vconn *vconn, enum vconn_wait_type type);
+};
+\f
+/* Passive virtual connection to an OpenFlow device.
+ *
+ * This structure should be treated as opaque by vconn implementations. */
+struct pvconn {
+ struct pvconn_class *class;
+ char *name;
+};
+
+void pvconn_init(struct pvconn *, struct pvconn_class *, const char *name);
+static inline void pvconn_assert_class(const struct pvconn *pvconn,
+ const struct pvconn_class *class)
+{
+ assert(pvconn->class == class);
+}
+
+struct pvconn_class {
+ /* Prefix for connection names, e.g. "ptcp", "pssl". */
+ const char *name;
+
+ /* Attempts to start listening for OpenFlow connections. 'name' is the
+ * full connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4".
+ * This name is useful for error messages but must not be modified.
+ *
+ * 'suffix' is a copy of 'name' following the colon and may be modified.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. If
+ * successful, stores a pointer to the new connection in '*pvconnp'.
+ *
+ * The listen function must not block. If the connection cannot be
+ * completed immediately, it should return EAGAIN (not EINPROGRESS, as
+ * returned by the connect system call) and continue the connection in the
+ * background. */
+ int (*listen)(const char *name, char *suffix, struct pvconn **pvconnp);
+
+ /* Closes 'pvconn' and frees associated memory. */
+ void (*close)(struct pvconn *pvconn);
+
+ /* Tries to accept a new connection on 'pvconn'. If successful, stores the
+ * new connection in '*new_vconnp' and returns 0. Otherwise, returns a
+ * positive errno value.
+ *
+ * The accept function must not block waiting for a connection. If no
+ * connection is ready to be accepted, it should return EAGAIN. */
+ int (*accept)(struct pvconn *pvconn, struct vconn **new_vconnp);
+
+ /* Arranges for the poll loop to wake up when a connection is ready to be
+ * accepted on 'pvconn'. */
+ void (*wait)(struct pvconn *pvconn);
};
+/* Active and passive vconn classes. */
+extern struct vconn_class tcp_vconn_class;
+extern struct pvconn_class ptcp_pvconn_class;
+extern struct vconn_class unix_vconn_class;
+extern struct pvconn_class punix_pvconn_class;
+#ifdef HAVE_OPENSSL
+extern struct vconn_class ssl_vconn_class;
+extern struct pvconn_class pssl_pvconn_class;
+#endif
+#ifdef HAVE_NETLINK
+extern struct vconn_class netlink_vconn_class;
+#endif
+
#endif /* vconn-provider.h */
git://git.onelab.eu / sliver-openvswitch.git / blobdiff