Interface: tos.lib.byte_radio.PhySend

interface PhySend

This interface is similar to the Send interface. This interface provides the basic functionality of the Send interface in async context. It is provided by the Phy Layer.

See:
Send
Author:
Philipp Huppertz

Commands
command error_t send(message_t *msg, uint8_t len) Send a packet with a data payload of len.

Events
event void sendDone(message_t *msg, error_t error) Signaled in response to an accepted send request.

Commands - Details

send

command error_t send(message_t *msg, uint8_t len)

Send a packet with a data payload of len. To determine the maximum available size, use the Packet interface of the component providing Send. If send returns SUCCESS, then the component will signal the sendDone event in the future; if send returns an error, it will not signal sendDone. Note that a component may accept a send request which it later finds it cannot satisfy; in this case, it will signal sendDone with an appropriate error code.

Parameters:
msg - the packet to send
len - the length of the packet payload
Returns:
SUCCESS if the request was accepted and will issue a sendDone event, EBUSY if the component cannot accept the request now but will be able to later, FAIL if the stack is in a state that cannot accept requests (e.g., it's off).

Events - Details

sendDone

event void sendDone(message_t *msg, error_t error)

Signaled in response to an accepted send request. msg is the sent buffer, and error indicates whether the send was succesful, and if not, the cause of the failure.

Parameters:
msg - the message which was requested to send
error - SUCCESS if it was transmitted successfully, FAIL if it was not.