filedir.nc

传感器网络中的嵌入式操作系统源代码

// $Id: FileDir.nc,v 1.1.4.2 2003/08/18 22:09:47 cssharp Exp $

/*									tab:4
 * "Copyright (c) 2000-2003 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."
 *
 * Copyright (c) 2002-2003 Intel Corporation
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE     
 * file. If you do not find these files, copies can be found by writing to
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300, Berkeley, CA, 
 * 94704.  Attention:  Intel License Inquiry.
 */
/**
 * List files in filing system
 */
interface FileDir {
  /**
   * List names of all files in filing system. Filing system is busy
   * until FAIL is returned from <code>readNext</code> or no more
   * files remain.
   * @return 
   *   SUCCESS: files can be read with <code>readNext</code>
   *   FAIL: filesystem is busy
   */
  command result_t start();

  /**
   * Return next file in filing system
   *
   * @return
   *   SUCCESS: attempt proceeds, <code>nextFile</code> will be signaled
   *   FAIL: no file list operation is in progress.
   */
  command result_t readNext();

  /**
   * Report next file name. 
   * @param filename One of the files in the filing system if 
   *   <code>result</code> is FS_OK, NULL otherwise. The storage for
   *   filename only remains valid until the end of the event.
   * @param result
   *   FS_OK filename is the next file.
   *   FS_NO_MORE_FILES No more files.
   *   FS_ERROR_xxx Filing system data is corrupt.
   * @return
   *   SUCCESS: continue reporting file names<br>
   *   FAIL: abort the file lising operation<br>
   * If the <code>result</code> is an error or no more files, the file
   * listing operation terminates.
   */
  event result_t nextFile(const char *filename, fileresult_t result);

  /**
   * @return Number of bytes available in filing system.
   */
  command uint32_t freeBytes();
}