Interface: tos.interfaces.Read

interface Read<typedef val_t>

The Read interface is intended for split-phase low-rate or high-latency reading of small values. The type of the value is given as a template argument. Because this interface is split-phase, these values may be backed by hardware, or a long-running computation.

See TEP114 - SIDs: Source and Sink Independent Drivers for details.

Parameters:: val_t - the type of the object that will be returned
Author:: Gilman Tolle <gtolle@archrock.com>
Version:: $Revision: 1.4 $ $Date: 2006/12/12 18:23:14 $

Commands

command error_t read() Initiates a read of the value.

Events

event void readDone(error_t result, val_t val) Signals the completion of the read().

Commands - Details

read

command error_t read()

Initiates a read of the value.

Returns:: SUCCESS if a readDone() event will eventually come back.

Events - Details

readDone

event void readDone(error_t result, val_t val)

Signals the completion of the read().

Parameters:: result - SUCCESS if the read() was successful; val - the value that has been read