LXR linux/net/tipc/subscr.h

   1/*
   2 * net/tipc/subscr.h: Include file for TIPC network topology service
   3 *
   4 * Copyright (c) 2003-2006, Ericsson AB
   5 * Copyright (c) 2005-2007, 2012-2013, Wind River Systems
   6 * All rights reserved.
   7 *
   8 * Redistribution and use in source and binary forms, with or without
   9 * modification, are permitted provided that the following conditions are met:
  10 *
  11 * 1. Redistributions of source code must retain the above copyright
  12 *    notice, this list of conditions and the following disclaimer.
  13 * 2. Redistributions in binary form must reproduce the above copyright
  14 *    notice, this list of conditions and the following disclaimer in the
  15 *    documentation and/or other materials provided with the distribution.
  16 * 3. Neither the names of the copyright holders nor the names of its
  17 *    contributors may be used to endorse or promote products derived from
  18 *    this software without specific prior written permission.
  19 *
  20 * Alternatively, this software may be distributed under the terms of the
  21 * GNU General Public License ("GPL") version 2 as published by the Free
  22 * Software Foundation.
  23 *
  24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34 * POSSIBILITY OF SUCH DAMAGE.
  35 */
  36
  37#ifndef _TIPC_SUBSCR_H
  38#define _TIPC_SUBSCR_H
  39
  40#include "server.h"
  41
  42struct tipc_subscription;
  43struct tipc_subscriber;
  44
  45/**
  46 * struct tipc_subscription - TIPC network topology subscription object
  47 * @subscriber: pointer to its subscriber
  48 * @seq: name sequence associated with subscription
  49 * @timeout: duration of subscription (in ms)
  50 * @filter: event filtering to be done for subscription
  51 * @timer: timer governing subscription duration (optional)
  52 * @nameseq_list: adjacent subscriptions in name sequence's subscription list
  53 * @subscription_list: adjacent subscriptions in subscriber's subscription list
  54 * @server_ref: object reference of server port associated with subscription
  55 * @swap: indicates if subscriber uses opposite endianness in its messages
  56 * @evt: template for events generated by subscription
  57 */
  58struct tipc_subscription {
  59        struct tipc_subscriber *subscriber;
  60        struct tipc_name_seq seq;
  61        u32 timeout;
  62        u32 filter;
  63        struct timer_list timer;
  64        struct list_head nameseq_list;
  65        struct list_head subscription_list;
  66        int swap;
  67        struct tipc_event evt;
  68};
  69
  70int tipc_subscr_overlap(struct tipc_subscription *sub, u32 found_lower,
  71                        u32 found_upper);
  72
  73void tipc_subscr_report_overlap(struct tipc_subscription *sub, u32 found_lower,
  74                                u32 found_upper, u32 event, u32 port_ref,
  75                                u32 node, int must);
  76
  77int tipc_subscr_start(void);
  78
  79void tipc_subscr_stop(void);
  80
  81#endif
  82