lib/vconn.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 <assert.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24
  25 #include "flow.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 struct list;
  32 struct ofpbuf;
  33 struct ofp_action_header;
  34 struct ofp_header;
  35 struct ofp_match;
  36 struct ofp_stats_msg;
  37 struct pvconn;
  38 struct vconn;
  39
  40 void vconn_usage(bool active, bool passive, bool bootstrap);
  41
  42 /* Active vconns: virtual connections to OpenFlow devices. */
  43 int vconn_verify_name(const char *name);
  44 int vconn_open(const char *name, int min_version, struct vconn **);
  45 void vconn_close(struct vconn *);
  46 const char *vconn_get_name(const struct vconn *);
  47 ovs_be32 vconn_get_remote_ip(const struct vconn *);
  48 ovs_be16 vconn_get_remote_port(const struct vconn *);
  49 ovs_be32 vconn_get_local_ip(const struct vconn *);
  50 ovs_be16 vconn_get_local_port(const struct vconn *);
  51 int vconn_connect(struct vconn *);
  52 int vconn_recv(struct vconn *, struct ofpbuf **);
  53 int vconn_send(struct vconn *, struct ofpbuf *);
  54 int vconn_recv_xid(struct vconn *, ovs_be32 xid, struct ofpbuf **);
  55 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
  56 int vconn_transact_noreply(struct vconn *, struct ofpbuf *, struct ofpbuf **);
  57 int vconn_transact_multiple_noreply(struct vconn *, struct list *requests,
  58                                     struct ofpbuf **replyp);
  59
  60 void vconn_run(struct vconn *);
  61 void vconn_run_wait(struct vconn *);
  62
  63 int vconn_open_block(const char *name, int min_version, struct vconn **);
  64 int vconn_send_block(struct vconn *, struct ofpbuf *);
  65 int vconn_recv_block(struct vconn *, struct ofpbuf **);
  66
  67 enum vconn_wait_type {
  68     WAIT_CONNECT,
  69     WAIT_RECV,
  70     WAIT_SEND
  71 };
  72 void vconn_wait(struct vconn *, enum vconn_wait_type);
  73 void vconn_connect_wait(struct vconn *);
  74 void vconn_recv_wait(struct vconn *);
  75 void vconn_send_wait(struct vconn *);
  76
  77 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
  78 int pvconn_verify_name(const char *name);
  79 int pvconn_open(const char *name, struct pvconn **);
  80 const char *pvconn_get_name(const struct pvconn *);
  81 void pvconn_close(struct pvconn *);
  82 int pvconn_accept(struct pvconn *, int min_version, struct vconn **);
  83 void pvconn_wait(struct pvconn *);
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif /* vconn.h */