SFBSpineReflex Class Reference

A 'convenience class' (with a prebuilt instance Spine) which provides a means of declaring reflexes that trigger at the "spine" -- i.e., after the individual faces, but before the Brain. More...

#include <SFBReactor.h>


Public Member Functions

void reflex (const char type, PacketHandler ph)
 A convenience method to specify that packets of the given 'type' should trigger the PacketHandler 'ph' if and when they reach the spine.


Detailed Description

A 'convenience class' (with a prebuilt instance Spine) which provides a means of declaring reflexes that trigger at the "spine" -- i.e., after the individual faces, but before the Brain.

A call like:

   Spine.reflex('z',myZSpineHandler);

is entirely equivalent to the call:

   reflex('z',myZSpineHandler, SFBReactor::TRIGGER_SPINE);

Member Function Documentation

void SFBSpineReflex::reflex ( const char  type,
PacketHandler  ph 
) [inline]

A convenience method to specify that packets of the given 'type' should trigger the PacketHandler 'ph' if and when they reach the spine.

Parameters:
type The type to associate, corresponding to the first byte of a packet that can trigger this reflex.
ph The handler to call when a 'type' packet reaches the spine.
Blinks:
E_API_BAD_REFLEX If 'type' is an upper-case alphabetic, since those are reserved for the reflex library.


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

Generated on Fri Apr 22 06:57:31 2011 for SFB by doxygen 1.5.9