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  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the names of the copyright holders nor the names of its
  18  *    contributors may be used to endorse or promote products derived from
  19  *    this software without specific prior written permission.
  20  *
  21  * Alternatively, this software may be distributed under the terms of the
  22  * GNU General Public License ("GPL") version 2 as published by the Free
  23  * Software Foundation.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef _TIPC_NODE_SUBSCR_H
  39 #define _TIPC_NODE_SUBSCR_H
  40
  41 #include "addr.h"
  42
  43 typedef void (*net_ev_handler) (void *usr_handle);
  44
  45 /**
  46  * struct node_subscr - "node down" subscription entry
  47  * @node: ptr to node structure of interest (or NULL, if none)
  48  * @handle_node_down: routine to invoke when node fails
  49  * @usr_handle: argument to pass to routine when node fails
  50  * @nodesub_list: adjacent entries in list of subscriptions for the node
  51  */
  52
  53 struct node_subscr {
  54         struct node *node;
  55         net_ev_handler handle_node_down;
  56         void *usr_handle;
  57         struct list_head nodesub_list;
  58 };
  59
  60 void nodesub_subscribe(struct node_subscr *node_sub, u32 addr,
  61                        void *usr_handle, net_ev_handler handle_down);
  62 void nodesub_unsubscribe(struct node_subscr *node_sub);
  63
  64 #endif