X-Git-Url: https://oss.titaniummirror.com/gitweb/?p=tinyos-2.x.git;a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2FMCPS%2FMCPS_PURGE.nc;h=e8bc3fe79b64877fea0769ac2bb2a27b3be2c676;hp=c598a15f5a4b0d830954b30c2bdef570b6a13e42;hb=e9bfab607e051bae6afb47b44892ce37541d1b44;hpb=adf1de6c009d13b7b52e68535c63b28f59c97400 diff --git a/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_PURGE.nc b/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_PURGE.nc index c598a15f..e8bc3fe7 100644 --- a/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_PURGE.nc +++ b/tos/lib/mac/tkn154/interfaces/MCPS/MCPS_PURGE.nc @@ -33,17 +33,23 @@ * ======================================================================== */ +/** + * The MCPS-PURGE.request primitive allows the next higher layer to purge an + * MSDU from the transaction queue. (IEEE 802.15.4-2006, Sect. 7.1.1) + */ + #include "TKN154.h" interface MCPS_PURGE { /** - * Request to purge a frame from the transaction queue. - * The result will be returned immediately (there - * is no confirm event for this command). + * Requests to purge a frame from the transaction queue. The result + * will be returned immediately (there is no confirm event for this + * command). * * @param msduHandle The handle of the frame to be purged from the * transaction queue + * * @return IEEE154_SUCCESS if the request succeeded, an * appropriate error code otherwise */