lib/vconn.h

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