lib/vconn.h

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