delugepagetransfer.nc

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

// $Id: DelugePageTransfer.nc,v 1.4 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."
 *
 */

/**
 * Handles the transfer of individual data pages between neighboring
 * nodes.
 *
 * @author Jonathan Hui <[e-mail]>
 */

interface DelugePageTransfer {

  /**
   * Tell the <code>DelugePageTransfer</code> to start requesting data
   * from a given node. 
   *
   * @param sourceAddr  The address of a node to request new data from.
   * @return            <code>SUCCESS</code>
   *                    <code>FAIL</code> otherwise.
   */
  command result_t setNewSource(uint16_t sourceAddr);

  /**
   * Notify that transferring of data pages has begun.
   *
   * @return <code>SUCCESS</code> if the event is handled successfully;
   *         <code>FAIL</code> otherwise.
   */
  event   result_t transferBegin();

  /**
   * Notify that transferring of data pages has completed.
   *
   * @return <code>SUCCESS</code> if the event is handled successfully;
   *         <code>FAIL</code> otherwise.
   */
  event   result_t transferDone();

  /**
   * Notify that a new data page has been received and is available
   * for sending.
   *
   * @return <code>SUCCESS</code> if the event is handled successfully;
   *         <code>FAIL</code> otherwise.
   */
  event   result_t receivedNewData();

  /**
   * Notify that packets from nodes that are behind have been
   * overheard.
   *
   * @return <code>SUCCESS</code> if the event is handled successfully;
   *         <code>FAIL</code> otherwise.
   */
  event   result_t overheardOlderData();

}