net/tipc/node_subscr.h

   1 /*
   2  * net/tipc/node_subscr.h: Include file for TIPC "node down" subscription handling
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2005, Wind River Systems
   6  * Copyright (c) 2005-2006, Ericsson AB
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  *
  12  * Redistributions of source code must retain the above copyright notice, this
  13  * list of conditions and the following disclaimer.
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution.
  17  * Neither the names of the copyright holders nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _TIPC_NODE_SUBSCR_H
  35 #define _TIPC_NODE_SUBSCR_H
  36
  37 #include "addr.h"
  38
  39 typedef void (*net_ev_handler) (void *usr_handle);
  40
  41 /**
  42  * struct node_subscr - "node down" subscription entry
  43  * @node: ptr to node structure of interest (or NULL, if none)
  44  * @handle_node_down: routine to invoke when node fails
  45  * @usr_handle: argument to pass to routine when node fails
  46  * @nodesub_list: adjacent entries in list of subscriptions for the node
  47  */
  48
  49 struct node_subscr {
  50         struct node *node;
  51         net_ev_handler handle_node_down;
  52         void *usr_handle;
  53         struct list_head nodesub_list;
  54 };
  55
  56 void nodesub_subscribe(struct node_subscr *node_sub, u32 addr,
  57                        void *usr_handle, net_ev_handler handle_down);
  58 void nodesub_unsubscribe(struct node_subscr *node_sub);
  59
  60 #endif