delugemetadatastablestore.nc

来自「tinyos最新版」· NC 代码 · 共 75 行

// $Id: DelugeMetadataStableStore.nc,v 1.3 2004/07/27 18:29:48 jwhui Exp $

/*									tab:4
 *
 *
 * "Copyright (c) 2000-2004 The Regents of the University  of California.  
 * All rights reserved.
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the author appear in all copies of this software.
 * 
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
 * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 */

/**
 * Generic interface for reading and writing Deluge metadata to and
 * from stable storage.
 *
 * @author Jonathan Hui <[e-mail]>
 */

interface DelugeMetadataStableStore {

  /**
   * Reads metadata information for stable storage.
   *
   * @param metadata  The buffer to put read metadata.
   * @return          <code>SUCCESS</code> if the read request is successful;
   *                  <code>FAIL</code> otherwise.
   */
  command result_t getMetadata(DelugeMetadata* metadata);

  /**
   * Notify that the read of metadata has completed.
   *
   * @param result  <code>SUCCESS</code> if the read completed successfuly;
   *                <code>FAIL</code> otherwise.
   * @return        <code>SUCCESS</code> if the event is handled successfully;
   *                <code>FAIL</code> otherwise.
   */
  event   result_t getMetadataDone(result_t result);

  /**
   * Write metadata to stable storage.
   *
   * @param metadata  The metadata to write to stable storage.
   * @return          <code>SUCCESS</code> if the write request is successful;
   *                  <code>FAIL</code> otherwise.
   */
  command result_t writeMetadata(DelugeMetadata* metadata);

  /**
   * Notify that the write of metadata has completed
   *
   * @param result  <code>SUCCESS</code> if the write requested completed 
   *                successfully;
   *                <code>FAIL</code> otherwise.
   * @return        <code>SUCCESS</code> if the event is handled successfully;
   *                <code>FAIL</code> otherwise.
   */
  event   result_t writeMetadataDone(result_t result);
}