sharedmsgbuf.nc

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

// $Id: SharedMsgBuf.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."
 *
 */

/**
 * Simple component that allows sharing of message buffers through a
 * parameterized interface.
 *
 * @author Jonathan Hui <[e-mail]>
 */

interface SharedMsgBuf {

  /**
   * Get the pointer to a shared message buf.
   *
   * @return The pointer to the shared message buf.
   */
  command TOS_MsgPtr getMsgBuf();

  /**
   * Request a lock on the shared message buf.
   *
   * @return <code>SUCCESS</code> if the lock was acquired successfully;
   *         <code>FAIL</code> otherwise.
   */
  command result_t lock();

  /**
   * Release lock on shared message buf.
   *
   * @return <code>SUCCESS</code> if the lock was released successfully;
   */
  command result_t unlock();

  /**
   * Check if shared message buf is currently locked.
   *
   * @return <code>TRUE</code> if the shared message buf is locked;
   *         <code>FALSE</code> otherwise.
   */
  command bool isLocked();
}