lib/vconn.h

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