Interface: Network

The network interface provides TinyDB to trap and monitor network communication -- TupleRouter could simply be wired directly to the appropriate AM send / handlers, but the network monitors topology and filters events in a semi-intelligent way.

Eventually, we'd like to abstract out the parts of this that are similar to Alec's fancy routing from the parts that are TinyDB magic (e.g. snooped messages) from the parts that really are just wrappers around other components (e.g. setPot).

Implemented by NetworkC.td.

Author:

Sam Madden (madden@cs.berkeley.edu)

Components providing this interface:

tos.lib.TinyDB.NetworkC

Components requiring this interface:

tos.lib.TinyDB.TupleRouterM

Commands

• TinyDBError sendDataMessage(TOS_MsgPtr msg) Send out a message containing a tuple

  Parameters:	msg - The message to send
  Returns:	err_MsgSendFailed if message failed to xmit

• TinyDBError sendQueryMessage(TOS_MsgPtr msg) Send out a message containing (part of) a query

  Parameters:	msg - The message to send
  Returns:	err_MsgSendFailed if message failed to xmit

• TinyDBError sendQueryRequest(TOS_MsgPtr msg, uint16_t from) Send out a message requesting a neighbor describe a query

  Parameters:	msg - The message to send
  Returns:	err_MsgSendFailed if message failed to xmit

• result_t sendUart(char *msg, uint8_t amid)
• result_t forceTopology(uint8_t fanout) Limit the possible parents each mote can select

  Parameters:

  fanout - The branching factor of the topology tree

• result_t setCentralized(bool on) Route all the data to the root (perform no in-network aggregation)

  Parameters:

  on - Whether data should be routed to the root

• void endOfEpoch(void) Called whenever an epoch ends

• result_t outputDone(TOS_MsgPtr msg, uint8_t amId) Signalled when a message has been sent

  Parameters:

  msg - The message that was sent amId - the AMId of the message that was sent

• TOS_MsgPtr dataSub(TOS_MsgPtr msg) Signalled when a data (tuple) message is received from a neighbor

  Parameters:

  The - data message that was received

• TOS_MsgPtr querySub(TOS_MsgPtr msg) Signalled when a query message is received from a neighbor

  Parameters:

  msg - The query message that was received

• TOS_MsgPtr snoopedSub(TOS_MsgPtr msg, uint8_t msgid, bool parent) Signalled when a message not directed to us is heard (snooped)

  Parameters:

  msg - The message that was heard msgid - The amid of the message parent - If the message was sent by our parent

• TOS_MsgPtr queryRequestSub(TOS_MsgPtr msg) Signalled when a neighbor mote requests a query from us

  Parameters:

  The - message our neighbor sent