BIRNET Interface Reference

/opt/src/beast/birnet/birnetutils.hh

SYNOPSIS

class  Birnet::DataKey;
class  Birnet::DataList;
class  Birnet::DataList::Node;
class  Birnet::DataList::NodeBase;
class  Birnet::DataListContainer;
class  Birnet::Deletable;
class  Birnet::Deletable::DeletionHook;
class  Birnet::InitHook;
class  Birnet::ReferenceCountImpl;
class  Birnet::VirtualTypeid;
   
void  BREAKPOINT  ();
void  _birnet_init_threads  ();
const String  basename  (path);
RandIter  binary_lookup  (begin, end, cmp_elements, arg);
std::pair< RandIter, bool >  binary_lookup_fuzzy  (begin, end, cmp_elements, arg);
std::pair< RandIter, bool >  binary_lookup_insertion_pos  (begin, end, cmp_elements, arg);
RandIter  binary_lookup_sibling  (begin, end, cmp_elements, arg);
void  birnet_init  (argcp, argvp, app_name, ivalues);
void  birnet_runtime_problem  (ewran_tag, domain, file, line, funcname, msgformat, ...);
void void  birnet_runtime_problemv  (ewran_tag, domain, file, line, funcname, msgformat, msgargs);
bool  check  (file, mode);
uint  cleanup_add  (timeout_ms, destroy_data, data);
void  cleanup_force_handlers  ();
char*  cxx_demangle  (mangled_identifier);
const String  dirname  (path);
bool  equals  (file1, file2);
InitSettings  init_settings  ();
bool  init_value_bool  (value);
double  init_value_double  (value);
int64  init_value_int  (value);
void  invalid_type  ();
bool  isabs  (path);
const String  join  (frag0, frag1, frag2, frag3, frag4, frag5, frag6, frag7, frag8, frag9, frag10, frag11, frag12, frag13, frag14, frag15);
void*  malloc_aligned  (total_size, alignment, free_pointer);
void  memset4  (mem, filler, length);
void  raise_sigtrap  ();
Obj &  ref  (obj);
Obj*  ref  (obj);
Obj &  ref_sink  (obj);
Obj*  ref_sink  (obj);
void  sink  (obj);
void  sink  (obj);
const String  skip_root  (path);
int  string_cmp_uuid  (uuid_string1, uuid_string2);
String  string_from_bool  (value);
String  string_from_double  (value);
String  string_from_errno  (errno_val);
String  string_from_float  (value);
String  string_from_float  (value);
String  string_from_int  (value);
String  string_from_type  (value);
String  string_from_type< bool >  (value);
String  string_from_type< double >  (value);
String  string_from_type< float >  (value);
String  string_from_type< int >  (value);
String  string_from_type< int16 >  (value);
String  string_from_type< int64 >  (value);
String  string_from_type< uint >  (value);
String  string_from_type< uint16 >  (value);
String  string_from_type< uint64 >  (value);
String  string_from_uint  (value);
String  string_from_vector  (dvec, delim);
bool  string_has_int  (string);
bool  string_is_uuid  (uuid_string);
String  string_printf  (format, ...);
String  string_strip  (str);
bool  string_to_bool  (string);
double  string_to_double  (string);
double  string_to_float  (string);
int64  string_to_int  (string, base);
Type  string_to_type  (string);
bool  string_to_type< bool >  (string);
double  string_to_type< double >  (string);
float  string_to_type< float >  (string);
int  string_to_type< int >  (string);
int16  string_to_type< int16 >  (string);
int64  string_to_type< int64 >  (string);
uint  string_to_type< uint >  (string);
uint16  string_to_type< uint16 >  (string);
uint64  string_to_type< uint64 >  (string);
uint64  string_to_uint  (string, base);
vector< double >  string_to_vector  (string);
String  string_tolower  (str);
String  string_totitle  (str);
String  string_toupper  (str);
String String  string_vprintf  (format, vargs);
void  unref  (obj);
void  unref  (obj);
void  url_show  (url);
void  url_show_with_cookie  (url, url_title, cookie);
bool  url_test_show  (url);
bool  url_test_show_with_cookie  (url, url_title, cookie);
uint8*  zintern_decompress  (decompressed_size, cdata, cdata_size);
void  zintern_free  (dc_data);

DESCRIPTION

Birnet::DataKey

 /opt/src/beast/birnet/birnetutils.hh:434
class Birnet::DataKey
{
    DataKey  ();
  DataKey &  operator=  ();
    DataKey  ();
  Type  fallback  ();
  void  destroy  (data);
  virtual  ~DataKey  ();
};

   
  DataKey  
();

DataKey &  operator=  
();

  DataKey  
();

Type  fallback  
();

void  destroy  
(Type data);

virtual  ~DataKey  
();

Birnet::DataList

 /opt/src/beast/birnet/birnetutils.hh:445
class Birnet::DataList
{
  NodeBase *nodes;
    DataList  ();
  void  set  (key, data);
  T  get  (key);
  T  swap  (key, data);
  T  swap  (key);
  void  del  (key);
  void  clear_like_destructor  ();
    ~DataList  ();
  void  set_data  (node);
  NodeBase*  get_data  (key);
  NodeBase*  rip_data  (key);
};

   
  DataList  
();

void  set  
(DataKey< T > *key,
 T             data);

T  get  
(DataKey< T > *key);

T  swap  
(DataKey< T > *key,
 T             data);

T  swap  
(DataKey< T > *key);

void  del  
(DataKey< T > *key);

void  clear_like_destructor  
();

  ~DataList  
();

void  set_data  
(NodeBase *node);

NodeBase*  get_data  
(DataKey< void > *key);

NodeBase*  rip_data  
(DataKey< void > *key);

Birnet::DataList::Node

 /opt/src/beast/birnet/birnetutils.hh:455
class Birnet::DataList::Node
{
  T data;
  T  get_data  ();
  T  swap  (d);
  virtual  ~Node  ();
    Node  (k, d);
};

   
T  get_data  
();

T  swap  
(T d);

virtual  ~Node  
();

  Node  
(DataKey< T > *k,
 T             d);

Birnet::DataList::NodeBase

 /opt/src/beast/birnet/birnetutils.hh:446
class Birnet::DataList::NodeBase
{
  NodeBase        *next;
  DataKey< void > *key;
    NodeBase  (k);
  virtual  ~NodeBase  ();
};

   
  NodeBase  
(DataKey< void > *k);

virtual  ~NodeBase  
();

Birnet::DataListContainer

 /opt/src/beast/birnet/birnetutils.hh:545
class Birnet::DataListContainer
{
  DataList data_list;
  void  set_data  (key, data);
  Type  get_data  (key);
  Type  swap_data  (key, data);
  Type  swap_data  (key);
  void  delete_data  (key);
};

   
void  set_data  
(DataKey< Type > *key,
 Type             data);

Type  get_data  
(DataKey< Type > *key);

Type  swap_data  
(DataKey< Type > *key,
 Type             data);

Type  swap_data  
(DataKey< Type > *key);

void  delete_data  
(DataKey< Type > *key);

Birnet::Deletable

 /opt/src/beast/birnet/birnetutils.hh:234
class Birnet::Deletable
{
  void  add_deletion_hook  (hook);
  void  remove_deletion_hook  (hook);
  void  invoke_deletion_hooks  ();
  virtual  ~Deletable  ();
};
Deletable is a virtual base class that can be derived from (usually with public virtual) to ensure an object has a vtable and a virtual destructor. Also, it allows deletion hooks to be called during the objects destructor, by deriving from Birnet::Deletable::DeletionHook. No extra per-object space is consumed to allow deletion hooks, which makes Deletable a suitable base type for classes that may or may not need this feature (e.g. objects that can but often aren't used for signal handler connections).
   
void  add_deletion_hook  
(DeletionHook *hook);
Add an uninstalled deletion hook to the deletable. This function is MT-safe and may be called from any thread.
hook: valid deletion hook

void  remove_deletion_hook  
(DeletionHook *hook);
Remove a previously added deletion hook. This function is MT-safe and may be called from any thread.
hook: valid deletion hook

void  invoke_deletion_hooks  
();
Invoke all deletion hooks installed on this deletable.

virtual  ~Deletable  
();

Birnet::Deletable::DeletionHook

 /opt/src/beast/birnet/birnetutils.hh:239
class Birnet::Deletable::DeletionHook
{
  DeletionHook *prev;
  DeletionHook *next;
  virtual  ~DeletionHook  ();
  void  monitoring_deletable  (deletable);
  void  dismiss_deletable  ();
    DeletionHook  ();
  bool  deletable_add_hook  (any);
  bool  deletable_add_hook  (deletable);
  bool  deletable_remove_hook  (any);
  bool  deletable_remove_hook  (deletable);
};
DeletionHook is the base implementation class for hooks which are hooked up into the deletion phase of a Birnet::Deletable.
   
virtual  ~DeletionHook  
();

void  monitoring_deletable  
(Deletable  &deletable);

void  dismiss_deletable  
();

  DeletionHook  
();

bool  deletable_add_hook  
(void *any);

bool  deletable_add_hook  
(Deletable *deletable);
Adds the deletion hook to deletable if it is non NULL. The deletion hook is asserted to be so far uninstalled. This function is MT-safe and may be called from any thread.
deletable: possible Deletable* handle
RETURNS: TRUE if the hook was added

bool  deletable_remove_hook  
(void *any);

bool  deletable_remove_hook  
(Deletable *deletable);
Removes the deletion hook from deletable if it is non NULL. The deletion hook is asserted to be installed on deletable. This function is MT-safe and may be called from any thread.
deletable: possible Deletable* handle
RETURNS: TRUE if the hook was removed

Birnet::InitHook

 /opt/src/beast/birnet/birnetutils.hh:90
class Birnet::InitHook
{
  InitHook    *next;
  int          priority;
  InitHookFunc hook;
    BIRNET_PRIVATE_CLASS_COPY  ();
  void  invoke_hooks  ();
    InitHook  (_func, _priority);
};

   
  BIRNET_PRIVATE_CLASS_COPY  
();

void  invoke_hooks  
();

  InitHook  
(InitHookFunc _func,
 int          _priority);

Birnet::ReferenceCountImpl

 /opt/src/beast/birnet/birnetutils.hh:264
class Birnet::ReferenceCountImpl
{
  uint32       ref_field;
  const uint32 FLOATING_FLAG;
  bool  ref_cas  (oldv, newv);
  uint32  ref_get  ();
  uint32  ref_count  ();
  void  finalize  ();
  void  delete_this  ();
  virtual  ~ReferenceCountImpl  ();
    ReferenceCountImpl  ();
  bool  floating  ();
  void  ref  ();
  void  ref_sink  ();
  bool  finalizing  ();
  void  unref  ();
  void  ref_diag  (msg);
  Obj &  ref  (obj);
  Obj*  ref  (obj);
  Obj &  ref_sink  (obj);
  Obj*  ref_sink  (obj);
  void  unref  (obj);
  void  unref  (obj);
  void  sink  (obj);
  void  sink  (obj);
};

   
bool  ref_cas  
(uint32 oldv,
 uint32 newv);

uint32  ref_get  
();

uint32  ref_count  
();

void  finalize  
();

void  delete_this  
();

virtual  ~ReferenceCountImpl  
();

  ReferenceCountImpl  
();

bool  floating  
();

void  ref  
();

void  ref_sink  
();

bool  finalizing  
();

void  unref  
();

void  ref_diag  
(const char *msg);

Obj &  ref  
(Obj  &obj);

Obj*  ref  
(Obj *obj);

Obj &  ref_sink  
(Obj  &obj);

Obj*  ref_sink  
(Obj *obj);

void  unref  
(Obj  &obj);

void  unref  
(Obj *obj);

void  sink  
(Obj  &obj);

void  sink  
(Obj *obj);

Birnet::VirtualTypeid

 /opt/src/beast/birnet/birnetutils.hh:42
class Birnet::VirtualTypeid
{
  virtual  ~VirtualTypeid  ();
  String  typeid_name  ();
  String  typeid_pretty_name  ();
  String  cxx_demangle  (mangled_identifier);
};

   
virtual  ~VirtualTypeid  
();

String  typeid_name  
();

String  typeid_pretty_name  
();

String  cxx_demangle  
(const char *mangled_identifier);

BREAKPOINT

 /opt/src/beast/birnet/birnetutils.hh:109
void  BREAKPOINT  
();

_birnet_init_threads

 /opt/src/beast/birnet/birnetutils.hh:556
void  _birnet_init_threads  
();

basename

 /opt/src/beast/birnet/birnetutils.hh:165
const String  basename  
(const String  &path);

binary_lookup

 /opt/src/beast/birnet/birnetutils.hh:427
RandIter  binary_lookup  
(RandIter    begin,
 RandIter    end,
 Cmp         cmp_elements,
 const Arg  &arg);

binary_lookup_fuzzy

 /opt/src/beast/birnet/birnetutils.hh:369
std::pair< RandIter, bool >  binary_lookup_fuzzy  
(RandIter    begin,
 RandIter    end,
 Cmp         cmp_elements,
 const Arg  &arg);

binary_lookup_insertion_pos

 /opt/src/beast/birnet/birnetutils.hh:401
std::pair< RandIter, bool >  binary_lookup_insertion_pos  
(RandIter    begin,
 RandIter    end,
 Cmp         cmp_elements,
 const Arg  &arg);

binary_lookup_sibling

 /opt/src/beast/birnet/birnetutils.hh:414
RandIter  binary_lookup_sibling  
(RandIter    begin,
 RandIter    end,
 Cmp         cmp_elements,
 const Arg  &arg);

birnet_init

 /opt/s