concepts::Os_concept Class Reference

Basic concept for Os specialization. More...

Inherits concepts::BasicReturnValues_concept.

List of all members.

Public Types
enum	{   SUCCESS, ERR_UNSPEC, ERR_NOMEM, ERR_BUSY,   ERR_NOTIMPL, ERR_NETDOWN, ERR_HOSTUNREACH }
enum	StateValues { READY, NO_VALUE, INACTIVE }
Public Attributes
typedef	size_t
	Unsigned integer that represents length information.
typedef	block_data_t
	Data type used for raw data in message sending process.
typedef	Radio
	Standard Radio that is used for message sending and registration of message reception callback.
typedef	Timer
	Standard Timer that is used for message sending and registration of message reception callback.
typedef	Debug
	Standard Debug interface that is used for message sending and registration of message reception callback.

---

Detailed Description

Basic concept for Os specialization.

Each Os Model of the Os Concept (that is, an implementation for a specific system) provide default types for the basic Os facets (Radio, Timer, Debug). Hence, a routing algorithm can typically use Os::Radio as its Radio, but also accept a Radio as a template parameter, so that also special implementations can be passed to the algorithm.

Furthermore, an Os Model provides a size type size_t, which is used for any kind of size information and should be set to an unsigned integral type, and a default block data type block_data_t used for data buffers.

---

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

SUCCESS	Default return value of success.
ERR_UNSPEC	Unspecified error value - if no other fits.
ERR_NOMEM	Out of memory.
ERR_BUSY	Device or resource busy - try again later.
ERR_NOTIMPL	Function not implemented.
ERR_NETDOWN	Network is down.
ERR_HOSTUNREACH	No route to host.

enum concepts::BasicReturnValues_concept::StateValues [inherited]

Enumerator:

READY	Ready for asking for data.
NO_VALUE	Currently no data available.
INACTIVE	Currently inactive - so no values available.

---

Member Data Documentation

typedef concepts::Os_concept::block_data_t

Data type used for raw data in message sending process.

Usually an uint8_t.

typedef concepts::Os_concept::Debug

Standard Debug interface that is used for message sending and registration of message reception callback.

If no Debug interface is passed to an algorithm, it is able to get a standard one over a model of the Os Facet.

typedef concepts::Os_concept::Radio

Standard Radio that is used for message sending and registration of message reception callback.

If no Radio is passed to an algorithm, it is able to get a standard one over a model of the Os Facet.

typedef concepts::Os_concept::size_t

Unsigned integer that represents length information.

typedef concepts::Os_concept::Timer

Standard Timer that is used for message sending and registration of message reception callback.

If no Timer is passed to an algorithm, it is able to get a standard one over a model of the Os Facet.

---

The documentation for this class was generated from the following file:

• doc/concepts/extiface/os.dox