secchan/port-watcher.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef PORT_WATCHER_H
  35 #define PORT_WATCHER_H 1
  36
  37 #include <stdint.h>
  38 #include "compiler.h"
  39 #include "secchan.h"
  40
  41 struct ofp_phy_port;
  42 struct port_watcher;
  43 struct secchan;
  44
  45 void port_watcher_start(struct secchan *,
  46                         struct rconn *local, struct rconn *remote,
  47                         struct port_watcher **);
  48 bool port_watcher_is_ready(const struct port_watcher *);
  49 uint32_t port_watcher_get_config(const struct port_watcher *,
  50                                  uint16_t port_no);
  51 const char *port_watcher_get_name(const struct port_watcher *,
  52                                   uint16_t port_no) UNUSED;
  53 const uint8_t *port_watcher_get_hwaddr(const struct port_watcher *,
  54                                        uint16_t port_no);
  55 void port_watcher_set_flags(struct port_watcher *, uint16_t port_no,
  56                             uint32_t config, uint32_t c_mask,
  57                             uint32_t state, uint32_t s_mask);
  58
  59 typedef void port_changed_cb_func(uint16_t port_no,
  60                                   const struct ofp_phy_port *old,
  61                                   const struct ofp_phy_port *new,
  62                                   void *aux);
  63
  64 void port_watcher_register_callback(struct port_watcher *,
  65                                     port_changed_cb_func *port_changed,
  66                                     void *aux);
  67
  68 typedef void local_port_changed_cb_func(const struct ofp_phy_port *new,
  69                                         void *aux);
  70
  71 void port_watcher_register_local_port_callback(struct port_watcher *pw,
  72                                                local_port_changed_cb_func *cb,
  73                                                void *aux);
  74
  75 void get_port_name(const struct ofp_phy_port *, char *name, size_t name_size);
  76
  77 #endif /* port-watcher.h */