src/charon/plugins/ha_sync/ha_sync_ctl.h

   1 /*
   2  * Copyright (C) 2008 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  *
  15  * $Id$
  16  */
  17
  18 /**
  19  * @defgroup ha_sync_ctl ha_sync_ctl
  20  * @{ @ingroup ha_sync
  21  */
  22
  23 #ifndef HA_SYNC_CTL_H_
  24 #define HA_SYNC_CTL_H_
  25
  26 #include "ha_sync_segments.h"
  27
  28 typedef struct ha_sync_ctl_t ha_sync_ctl_t;
  29
  30 /**
  31  * HA Sync control interface using a FIFO.
  32  */
  33 struct ha_sync_ctl_t {
  34
  35         /**
  36          * Destroy a ha_sync_ctl_t.
  37          */
  38         void (*destroy)(ha_sync_ctl_t *this);
  39 };
  40
  41 /**
  42  * Create a ha_sync_ctl instance.
  43  *
  44  * @param segments      segments to control
  45  * @return                      HA sync control interface
  46  */
  47 ha_sync_ctl_t *ha_sync_ctl_create(ha_sync_segments_t *segments);
  48
  49 #endif /* HA_SYNC_CTL_ @}*/