src/lib/pubsub/pubsub_flags.h

   1 /* Copyright (c) 2001, Matej Pfajfar.
   2  * Copyright (c) 2001-2004, Roger Dingledine.
   3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   4  * Copyright (c) 2007-2021, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * @file pubsub_flags.h
   9  * @brief Flags that can be set on publish/subscribe messages.
  10  **/
  11
  12 #ifndef TOR_PUBSUB_FLAGS_H
  13 #define TOR_PUBSUB_FLAGS_H
  14
  15 /**
  16  * Flag for registering a message: declare that no other module is allowed to
  17  * publish this message if we are publishing it, or subscribe to it if we are
  18  * subscribing to it.
  19  */
  20 #define DISP_FLAG_EXCL (1u<<0)
  21
  22 /**
  23  * Flag for registering a message: declare that this message is a stub, and we
  24  * will not actually publish/subscribe it, but that the dispatcher should
  25  * treat us as if we did when typechecking.
  26  *
  27  * We use this so that messages aren't treated as "dangling" if they are
  28  * potentially used by some other build of Tor.
  29  */
  30 #define DISP_FLAG_STUB (1u<<1)
  31
  32 #endif /* !defined(TOR_PUBSUB_FLAGS_H) */