Erlang Central

Difference between revisions of "Cascading Behaviours"

From ErlangCentral Wiki

m
m (Revert vandalism)
Line 1:Line 1:
[http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=18 cheap diazepam] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=312 cheap xenical] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=45 nokia ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=285 qwest ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=79 zanaflex online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=247 diazepam online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=305 verizon ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-226682379944.html free motorola ringtones] [http://climate.msrc.sunysb.edu/1984/messages/318.html order lortab] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=62 prozac online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=21 ericsson ringtones] [http://climate.msrc.sunysb.edu/1984/messages/330.html but ortho] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,19 cheap cyclobenzaprine] [http://climate.msrc.sunysb.edu/1984/messages/295.html cheap celexa] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=253 free ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=49 phentermine] [http://climate.msrc.sunysb.edu/1984/messages/300.html free cool ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=52 cheap prozac] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,44 free qwest ringtones] [http://climate.msrc.sunysb.edu/1984/messages/296.html cialis online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=297 sprint ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=60 nexium online] [http://climate.msrc.sunysb.edu/1984/messages/339.html real ringtones] [http://climate.msrc.sunysb.edu/1984/messages/341.html sagem ringtones] [http://climate.msrc.sunysb.edu/1984/messages/351.html tracfone ringtones] [http://climate.msrc.sunysb.edu/1984/messages/328.html free nokia ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=284 free punk ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-226172687200.html mp3 ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=295 sony ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,12 ativan online] [http://climate.msrc.sunysb.edu/1984/messages/309.html but hgh] [http://climate.msrc.sunysb.edu/1984/messages/320.html free midi ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=7 alltel ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=23 cheap flexeril] [http://climate.msrc.sunysb.edu/1984/messages/346.html sony ericsson ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=39 motorola ringtones] [http://climate.msrc.sunysb.edu/1984/messages/359.html vicodin online] [http://www.bc.edu/apps/bookstore/cards/jun7-226062830562.html free tracfone ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=42 buy soma] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=260 levitra online] [http://climate.msrc.sunysb.edu/1984/messages/322.html free motorola ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=19 cheap didrex] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=84 cheap sildenafil] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=48 pharmacy online online] [http://climate.msrc.sunysb.edu/1984/messages/366.html zoloft online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=257 hydrocodone online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=63 free sony ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=82 cingular ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=306 viagra] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=47 buy paxil] [http://climate.msrc.sunysb.edu/1984/messages/292.html ambien online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=264 buy lortab] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=28 order hydrocodone] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=85 vigrx online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=10 cheap ativan] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=26 hgh online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=63 sildenafil online] [http://climate.msrc.sunysb.edu/1984/messages/358.html buy viagra] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=71 ortho online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=44 nextel ringtones] [http://climate.msrc.sunysb.edu/1984/messages/316.html lisinopril] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,24 free funny ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,46 free sony ericsson ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=307 buy vicodin] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,25 hydrocodone] [http://climate.msrc.sunysb.edu/1984/messages/293.html order ativan] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=38 mono ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,18 clonazepam] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=31 levitra] [http://climate.msrc.sunysb.edu/1984/messages/349.html free sprint ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=49 cialis online] [http://climate.msrc.sunysb.edu/1984/messages/347.html sony ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,26 cheap levitra] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=313 zanaflex online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=44 phentermine] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=12 celexa online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=69 ultracet online] [http://climate.msrc.sunysb.edu/1984/messages/362.html wwe ringtones] [http://climate.msrc.sunysb.edu/1984/messages/343.html free sharp ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,36 buy norco] [http://climate.msrc.sunysb.edu/1984/messages/345.html soma online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=61 cheap ultracet] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=242 free cingular ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=232 cheap adipex] [http://climate.msrc.sunysb.edu/1984/messages/364.html cheap xenical] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=6 cheap albuterol] [http://climate.msrc.sunysb.edu/1984/messages/350.html cheap tenuate] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=83 cheap ortho] [http://climate.msrc.sunysb.edu/1984/messages/325.html free music ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=288 sagem ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=262 cheap lisinopril] [http://climate.msrc.sunysb.edu/1984/messages/319.html meridia online] [http://climate.msrc.sunysb.edu/1984/messages/335.html cheap propecia] [http://climate.msrc.sunysb.edu/1984/messages/360.html cheap vigrx] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=20 cheap diethylpropion] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=233 cheap albuterol] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=40 mp3 ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=265 meridia online] [http://climate.msrc.sunysb.edu/1984/messages/307.html free ringtones] [http://climate.msrc.sunysb.edu/1984/messages/354.html cheap ultram] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=61 soma online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=35 cheap lortab] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=292 cheap sildenafil] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,34 free nextel ringtones] [http://climate.msrc.sunysb.edu/1984/messages/317.html cheap lorazepam] [http://climate.msrc.sunysb.edu/1984/messages/308.html free funny ringtones] [http://climate.msrc.sunysb.edu/1984/messages/368.html diethylpropion online] [http://www.bc.edu/apps/bookstore/cards/jun7-226002359520.html free ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=76 funny ringtones] [http://climate.msrc.sunysb.edu/1984/messages/297.html cingular ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-224302380012.html cheap soma] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=274 nokia ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=55 clonazepam online] [http://climate.msrc.sunysb.edu/1984/messages/367.html zyban online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=64 clomid online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=283 buy prozac] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,53 online valium] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=33 order lisinopril] [http://www.bc.edu/apps/bookstore/cards/jun7-225692379850.html meridia online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=41 buy tramadol] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=60 sharp ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=266 free midi ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=252 flexeril online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=55 real ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=240 celexa online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=314 zoloft online] [http://climate.msrc.sunysb.edu/1984/messages/327.html free nextel ringtones] [http://climate.msrc.sunysb.edu/1984/messages/304.html ericsson ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,32 free music ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=41 mtv ringtones] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,52 order ultram] [http://climate.msrc.sunysb.edu/1984/messages/356.html buy valium] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,55 viagra online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=58 lorazepam online] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=13 cheap cialis] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,38 cheap phentermine] [http://climate.msrc.sunysb.edu/1984/messages/326.html buy nexium] [http://www.bc.edu/apps/bookstore/cards/jun7-226732674842.html samsung ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-225822801712.html cheap norco] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=52 meridia online] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,48 sprint ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=74 buy rivotril] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,15 order carisoprodol] [http://climate.msrc.sunysb.edu/1984/messages/294.html carisoprodol online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=246 cyclobenzaprine online] [http://climate.msrc.sunysb.edu/1984/messages/369.html free qwest ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-226472592872.html free qwest ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=47 cheap fioricet] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=72 verizon ringtones] [http://climate.msrc.sunysb.edu/1984/messages/337.html punk ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=256 cheap hoodia] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=279 pharmacy online online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=300 tracfone ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=301 tramadol] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=287 cheap rivotril] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=68 tramadol online] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,21 didrex online] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,22 cheap fioricet] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=271 music ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=65 cheap albuterol] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,35 free nokia ringtones] [http://www.bc.edu/apps/bookstore/cards/jun7-225582064618.html buy viagra] [http://climate.msrc.sunysb.edu/1984/messages/291.html buy alprazolam] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,59 buy xenical] [http://climate.msrc.sunysb.edu/1984/messages/332.html pharmacy online online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=254 free funny ringtones] [http://climate.msrc.sunysb.edu/1984/messages/365.html order zanaflex] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=250 free ericsson ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=17 cyclobenzaprine online] [http://www.bc.edu/apps/bookstore/cards/jun7-225772801698.html adipex online] [http://www.bc.edu/apps/bookstore/cards/jun7-224662404428.html cheap xanax] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,9 free alltel ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=54 free qwest ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=303 ultram online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=296 sonyericsson ringtones] [http://climate.msrc.sunysb.edu/1984/messages/342.html free samsung ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=73 cheap lortab] [http://climate.msrc.sunysb.edu/1984/messages/321.html free mono ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=59 free samsung ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=315 zyban online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=69 cheap celexa] [http://www.bc.edu/apps/bookstore/cards/jun7-226122830578.html free funny ringtones] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=310 wwe ringtones] [http://climate.msrc.sunysb.edu/1984/messages/340.html cheap rivotril] [http://climate.msrc.sunysb.edu/1984/messages/298.html but clomid] [http://climate.msrc.sunysb.edu/1984/messages/305.html buy fioricet] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=255 buy hgh] [http://climate.msrc.sunysb.edu/1984/messages/315.html cheap lipitor] [http://climate.msrc.sunysb.edu/1984/messages/310.html cheap hoodia] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=15 clonazepam online] [http://mrsrl.stanford.edu/seminar/detailview.php?event_id=245 cool ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=66 tenuate online] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=53 cheap vicodin] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=77 real ringtones] [http://climate.msrc.sunysb.edu/1984/messages/348.html free sonyericsson ringtones] [http://ocw201-1.usc.edu/iPIDD/ju_board/view.php?message_ID=27 buy hoodia] [http://climate.msrc.sunysb.edu/1984/messages/352.html buy tramadol] [http://www.bc.edu/apps/bookstore/cards/jun7-226422592864.html nextel ringtones] [http://groups.ku.edu/cgi-bin/cgiwrap/kuksa/forum/ezboard.cgi?db=general&action=read&dbf=54 cheap alprazolam] [http://brown.cla.sc.edu/projects/pas/bforum/index.php?method=showhtmllist&list=message&rollid=2,11 ambien online] ==Author==
+
==Author==
 
Vance Shipley
 
Vance Shipley
  
Line 47:Line 47:
 
<code caption="Code listing 2.4: Starting a Finite State Machine">
 
<code caption="Code listing 2.4: Starting a Finite State Machine">
  
2
+
2&gt; {ok, FSM} = gen_fsm:start(simple_fsm, [], []).
 +
{ok,&lt;0.36.0&gt;}
 +
 
 +
</code>
 +
 
 +
===Events===
 +
 
 +
To send an event to your finite state machine process you may call gen_fsm:send_event/2.
 +
 
 +
<code caption="Code listing 2.5: Sending an Event">
 +
 
 +
2&gt; gen_fsm:send_event(FSM, foo).
 +
 
 +
ok
 +
</code>
 +
 
 +
The result is that a message is sent to your FSM process tagged so that the gen_fsm module may recognize it as a gen_fsm generated event. When the main loop function in gen_fsm receives this message it will call the state handler callback in your module corresponding to the current state the FSM process is in.
 +
 
 +
==An Example FSM==
 +
 
 +
===The Module===
 +
 
 +
Below is a very simple example of a module implemented with a gen_fsm behaviour. In this module we will implement just one state and the only thing it will really do is to be chatty about what is going on.
 +
 
 +
<code caption="Code listing 3.1: A Chatty gen_fsm Callback Module">
 +
 
 +
-module(chatty_fsm).
 +
 
 +
-export([init/1, handle_event/3, handle_sync_event/4,
 +
        handle_info/3, terminate/3, code_change/4]).
 +
-export([idle/2]).
 +
 
 +
-behaviour(gen_fsm).
 +
 
 +
-record(state, {}).
 +
 
 +
init(Args) -&gt;
 +
    process_flag(trap_exit, true),
 +
    io:fwrite("gen_fsm called ~w:init(~w)~n", [?MODULE, Args]),
 +
    {ok, idle, #state{}}.
 +
 
 +
idle(Event, StateData) -&gt;
 +
    io:fwrite("gen_fsm called ~w:idle(~w, ~w)~n",
 +
        [?MODULE, Event, StateData]),
 +
    {next_state, idle, StateData}.
 +
 
 +
handle_event(Event, StateName, StateData) -&gt;
 +
    io:fwrite("gen_fsm called ~w:handle_event(~w, ~w, ~w)~n",
 +
        [?MODULE, Event, StateName, StateData]),
 +
    {next_state, StateName, StateData}.
 +
 
 +
handle_sync_event(Event, From, StateName, StateData) -&gt;
 +
    io:fwrite("gen_fsm called ~w:handle_sync_event(~w, ~w, ~w, ~w)~n",
 +
        [?MODULE, Event, From, StateName, StateData]),
 +
    {next_state, StateName, StateData}.
 +
 
 +
handle_info(Info, StateName, StateData) -&gt;
 +
    io:fwrite("gen_fsm called ~w:handle_info(~w, ~w, ~w)~n",
 +
        [?MODULE, Info, StateName, StateData]),
 +
    {next_state, StateName, StateData}.
 +
 
 +
terminate(Reason, StateName, StateData) -&gt;
 +
 
 +
    io:fwrite("gen_fsm called ~w:terminate(~w, ~w, ~w)~n",
 +
        [?MODULE, Reason, StateName, StateData]).
 +
 
 +
code_change(OldVsn, StateName, StateData, Extra) -&gt;
 +
    io:fwrite("gen_fsm called ~w:code_change(~w, ~w, ~w, ~w)~n",
 +
        [?MODULE, OldVsn, StateName, StateData, Extra]),
 +
    {ok, StateName, StateData}.
 +
 
 +
</code>
 +
 
 +
===Running the Chatty FSM===
 +
 
 +
When we start this module and send it an event as above we will see the functions in our callback module being called.
 +
 
 +
<code caption="Code listing 3.2: Starting the Chatty FSM">
 +
 
 +
1&gt; {ok, FSM} = gen_fsm:start(chatty_fsm, [], []).
 +
gen_fsm called chatty_fsm:init([])
 +
{ok,&lt;0.31.0&gt;}
 +
 
 +
</code>
 +
 
 +
<code caption="Code listing 3.3: Sending the Chatty FSM an Event">
 +
 
 +
2&gt; gen_fsm:send_event(FSM, foo).
 +
 
 +
gen_fsm called chatty_fsm:idle(foo, {state})
 +
ok
 +
 
 +
</code>
 +
 
 +
==Creating a New Behaviour==
 +
 
 +
===A Chatty FSM Behaviour===
 +
 
 +
Now we may decide that a chatty FSM is a useful thing in a very general way. If we want to make other FSMs chatty we can put this functionality into a behaviour which our FSM modules may behave to. The basic idea is that we will implement the callbacks which the gen_fsm module will call as pass through functions to the callbacks in the user's module. These pass through functions will simply perform the chattyness and then call the FSM module's identical callbacks.
 +
 
 +
===The Module===
 +
 
 +
<table class="ncontent" width="100%" border="0" cellspacing="0" cellpadding="0"><tr><td bgcolor="#bbffbb"><p class="note"><b>Note: </b>
 +
It is not suggested that this module performs a useful purpose as it is.
 +
There are better solutions to add event tracing including passing the
 +
gen_fsm start function the {debug, [trace]} option.  The intent is to
 +
demonstrate an enhanced behaviour.
 +
</p></td></tr></table>
 +
 
 +
<code caption="Code listing 4.1: A Chatty FSM Behaviour Module">
 +
 
 +
-module(chatty_fsm).
 +
 
 +
%% Export the same API as gen_fsm.
 +
-export([start/3, start/4, start_link/3, start_link/4,
 +
        send_event/2, sync_send_event/2, sync_send_event/3,
 +
        send_all_state_event/2, sync_send_all_state_event/2,
 +
        sync_send_all_state_event/3, reply/2, start_timer/2,
 +
        send_event_after/2,cancel_timer/1]).
 +
 
 +
%% Export the callbacks gen_fsm expects.
 +
-export([init/1, handle_event/3, handle_sync_event/4,
 +
        handle_info/3, terminate/3, code_change/4]).
 +
-export([state/2]).
 +
 
 +
%% Define the behaviour's required callbacks.
 +
-export([behaviour_info/1]).
 +
 
 +
behaviour_info(callbacks) -&gt;
 +
 
 +
    [{init,1},{handle_event,3},{handle_sync_event,4},
 +
        {handle_info,3}, {terminate,3},{code_change,4}];
 +
behaviour_info(_Other) -&gt;
 +
    undefined.
 +
 
 +
%% Define this module as a gen_fsm callback module.
 +
-behaviour(gen_fsm).
 +
 
 +
%% State data record.
 +
-record(state, {module, state, data}).
 +
 
 +
%% Users will use these start functions instead of gen_fsm's.
 +
%% We add the user's module name to the arguments and call
 +
%% gen_fsm's start function with our module name instead.
 +
 
 +
start(Mod, Args, Options) -&gt;
 +
    gen_fsm:start(?MODULE, [Mod, Args], Options).
 +
 
 +
start(Name, Mod, Args, Options) -&gt;
 +
    gen_fsm:start(Name, ?MODULE, [Mod, Args], Options).
 +
 
 +
start_link(Mod, Args, Options) -&gt;
 +
    gen_fsm:start_link(?MODULE, [Mod, Args], Options).
 +
 
 +
start_link(Name, Mod, Args, Options) -&gt;
 +
    gen_fsm:start_link(Name, ?MODULE, [Mod, Args], Options).
 +
 
 +
%% These functions are just pass through to gen_fsm.
 +
%% They are included for completeness only.
 +
 
 +
send_event(Name, Event) -&gt;
 +
    gen_fsm:send_event(Name, Event).
 +
 
 +
sync_send_event(Name, Event) -&gt;
 +
    gen_fsm:sync_send_event(Name, Event).
 +
 
 +
sync_send_event(Name, Event, Timeout) -&gt;
 +
    gen_fsm:sync_send_event(Name, Event, Timeout).
 +
 
 +
send_all_state_event(Name, Event) -&gt;
 +
    gen_fsm:send_all_state_event(Name, Event).
 +
 
 +
sync_send_all_state_event(Name, Event) -&gt;
 +
    gen_fsm:sync_send_all_state_event(Name, Event).
 +
 
 +
sync_send_all_state_event(Name, Event, Timeout) -&gt;
 +
 
 +
    gen_fsm:sync_send_all_state_event(Name, Event, Timeout).
 +
 
 +
start_timer(Time, Msg) -&gt;
 +
    gen_fsm:start_timer(Time, Msg).
 +
 
 +
send_event_after(Time, Event) -&gt;
 +
    gen_fsm:send_event_after(Time, Event).
 +
 
 +
cancel_timer(Ref) -&gt;
 +
    gen_fsm:cancel_timer(Ref).
 +
 
 +
reply(Caller, Reply) -&gt;
 +
    gen_fsm:reply(Caller, Reply).
 +
 
 +
%% Our start function above added the user's module name
 +
%% to the arguments.  We store this in our state data record.
 +
 
 +
%% After performing our chattyness we run the user's init/1
 +
%% and store the user's next state name and state data in
 +
%% our internal state data record for later reference.
 +
init([Mod, Args]) -&gt;
 +
    io:fwrite("~w:init(~w) -&gt; ", [Mod, Args]),
 +
    case Mod:init(Args) of
 +
        {ok, ExtStateName, ExtStateData} -&gt;
 +
            io:fwrite("    {ok, ~w, ~w}~n", [ExtStateName, ExtStateData]),
 +
            StateData = #state{module = Mod, state = ExtStateName,
 +
                data = ExtStateData},
 +
            {ok, state, StateData};
 +
        {ok, ExtStateName, ExtStateData, Timeout} -&gt;
 +
 
 +
            io:fwrite("    {ok, ~w, ~w, ~w}~n",
 +
                [ExtStateName, ExtStateData, Timeout]),
 +
            StateData = #state{module = Mod, state = ExtStateName,
 +
                data = ExtStateData},
 +
            {ok, state, StateData, Timeout};
 +
        {stop, Reason} -&gt;
 +
            io:fwrite("    {stop, ~w}~n", [Reason]),
 +
            {stop, Reason};
 +
        Other -&gt;
 +
            io:fwrite("    ~w~n", [Other]),
 +
            Other
 +
    end.
 +
 
 +
%% We use only one state handler for this module.
 +
%% After being chatty we look up the user's current state
 +
%% name and call that handler with the current event
 +
%% and the user's state data.
 +
 
 +
state(Event, StateData) -&gt;
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:~w(~w, ~w) -&gt;~n",
 +
        [Mod, ExtStateName, Event, ExtStateData]),
 +
    Result = Mod:ExtStateName(Event, ExtStateData),
 +
    handle_result(Result, state, StateData).
 +
 
 +
%% The other gen_fsm callbacks are handled the same as above.
 +
 
 +
handle_event(Event, StateName, StateData) -&gt;
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:handle_event(~w, ~w, ~w) -&gt;~n",
 +
        [Mod, Event, ExtStateName, ExtStateData]),
 +
    Result = Mod:handle_event(Event, ExtStateName, ExtStateData),
 +
    handle_result(Result, StateName, StateData).
 +
 
 +
handle_sync_event(Event, From, StateName, StateData) -&gt;
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:handle_sync_event(~w, ~w, ~w, ~w) -&gt;~n",
 +
        [Mod, Event, From, ExtStateName, ExtStateData]),
 +
    Result = Mod:handle_sync_event(Event, From, ExtStateName, ExtStateData),
 +
    handle_result(Result, StateName, StateData).
 +
 
 +
handle_info(Info, StateName, StateData) -&gt;
 +
 
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:handle_info(~w, ~w, ~w) -&gt;~n",
 +
        [Mod, Info, ExtStateName, ExtStateData]),
 +
    Result = Mod:handle_info(Info, ExtStateName, ExtStateData),
 +
    handle_result(Result, StateName, StateData).
 +
 
 +
terminate(Reason, _StateName, StateData) -&gt;
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:terminate(~w, ~w, ~w) -&gt;~n",
 +
        [Mod, Reason, ExtStateName, ExtStateData]),
 +
    Mod:terminate(Reason, ExtStateName, ExtStateData).
 +
 
 +
code_change(OldVsn, StateName, StateData, Extra) -&gt;
 +
    Mod = StateData#state.module,
 +
    ExtStateName = StateData#state.state,
 +
    ExtStateData = StateData#state.data,
 +
    io:fwrite("~w:code_change(~w, ~w, ~w, ~w) -&gt;~n",
 +
        [Mod, OldVsn, ExtStateName, ExtStateData, Extra]),
 +
    case Mod:code_change(OldVsn, ExtStateName, ExtStateData, Extra) of
 +
        {ok, NewExtStateName, NewExtStateData} -&gt;
 +
            io:fwrite("    {ok, ~w, ~w}~n",
 +
                NewExtStateName, NewExtStateData),
 +
            NewStateData = StateData#state{state = NewExtStateName,
 +
                data = NewExtStateData},
 +
            {ok, StateName, NewStateData};
 +
        Else -&gt;
 +
            Else
 +
    end.
 +
 
 +
%% This function handles the common result set of callbacks.
 +
 
 +
handle_result({next_state, NewExtStateName, NewExtStateData},
 +
        StateName, StateData) -&gt;
 +
    io:fwrite("    {next_state, ~w, ~w}~n",
 +
        [NewExtStateName, NewExtStateData]),
 +
    NewStateData = StateData#state{state = NewExtStateName,
 +
        data = NewExtStateData},
 +
    {next_state, StateName, NewStateData};
 +
handle_result({next_state, NewExtStateName, NewExtStateData, Timeout},
 +
        StateName, StateData) -&gt;
 +
    io:fwrite("    {next_state, ~w, ~w, ~w}~n",
 +
        [NewExtStateName, NewExtStateData, Timeout]),
 +
    NewStateData = StateData#state{state = NewExtStateName,
 +
        data = NewExtStateData},
 +
    {next_state, StateName, NewStateData, Timeout};
 +
handle_result({reply, Reply, NewExtStateName, NewExtStateData},
 +
        StateName, StateData) -&gt;
 +
    io:fwrite("    {reply, ~w, ~w, ~w}~n",
 +
        [Reply, NewExtStateName, NewExtStateData]),
 +
    NewStateData = StateData#state{state = NewExtStateName,
 +
        data = NewExtStateData},
 +
    {reply, Reply, StateName, NewStateData};
 +
handle_result({reply, Reply, NewExtStateName, NewExtStateData, Timeout},
 +
        StateName, StateData) -&gt;
 +
    io:fwrite("    {reply, ~w, ~w, ~w, ~w}~n",
 +
        [Reply, NewExtStateName, NewExtStateData, Timeout]),
 +
    NewStateData = StateData#state{state = NewExtStateName,
 +
        data = NewExtStateData},
 +
    {reply, Reply, StateName, NewStateData, Timeout};
 +
handle_result({stop, Reason, NewExtStateData}, _StateName, StateData) -&gt;
 +
    io:fwrite("    {stop, ~w, ~w}~n", [Reason, NewExtStateData]),
 +
    NewStateData = StateData#state{data = NewExtStateData},
 +
    {stop, Reason, NewStateData};
 +
handle_result({stop, Reason, Reply, NewExtStateData},
 +
        _StateName, StateData) -&gt;
 +
 
 +
    io:fwrite("    {stop, ~w, ~w, ~w}~n",
 +
        [Reason, Reply, NewExtStateData]),
 +
    NewStateData = StateData#state{data = NewExtStateData},
 +
    {stop, Reason, Reply, NewStateData};
 +
handle_result(Other, _StateName, _StateData) -&gt;
 +
    io:fwrite("    ~w~n", [Other]),
 +
    Other.
 +
</code>
 +
 
 +
==Using the New Behaviour==
 +
 
 +
===Module===
 +
 
 +
You write a callback module for chatty_fsm behaviours exactly as you would for gen_fsm.
 +
 
 +
<code caption="Code listing 5.1: Behaviour Attribute">
 +
 
 +
-behaviour(chatty_fsm).
 +
 
 +
</code>
 +
 
 +
<code caption="Code listing 5.2: Required chatty_fsm Callbacks">
 +
 
 +
-export([init/1, handle_event/3, handle_sync_event/4,
 +
        handle_info/3, terminate/3, code_change/4]).
 +
</code>
 +
<table class="ncontent" width="100%" border="0" cellspacing="0" cellpadding="0"><tr><td bgcolor="#bbffbb"><p class="note"><b>Note: </b>In this example we export an identical interface to the callback
 +
module as imported from gen_fsm.  In another example we might have defined
 +
a different list of required callbacks.</p></td></tr></table>
 +
<code caption="Code listing 5.3: State Handler Callbacks">
 +
 
 +
-export([idle/2, busy/2]).
 +
</code>
 +
===Startup===
 +
 
 +
We can now use chatty_fsm anywhere we would use gen_fsm. It exports the same API as gen_fsm and behaves identically only it adds chattyness.
 +
 
 +
<code caption="Code listing 5.4: Starting a chatty_fsm FSM">
 +
 
 +
1&gt; {ok, FSM} = chatty_fsm:start(simple_fsm, [], []).
 +
simple_fsm:init([]) -&gt;
 +
    {ok, idle, {state}}
 +
{ok,&lt;0.31.0&gt;}
 +
 
 +
</code>
 +
 
 +
<code caption="Code listing 5.5: Sending an Event">
 +
 
 +
2&gt; chatty_fsm:send_event(FSM, foo).
 +
simple_fsm:idle(foo, {state}) -&gt;
 +
ok    {next_state, idle, {state}}
 +
 
 +
</code>
 +
 
 +
You could write a simliar behaviour to do much more interesting things.
 +
 
 +
==Conclusion==
 +
 
 +
===Cascading Behaviours===
 +
 
 +
It has been shown that behaviour callback modules may also be behaviour modules. You may create a chain of callbacks of indefinite length.
 +
 
 +
An interesting example would be a complex finite state machine implemented in several behaviour modules such that the outermost had only a few states. Some of these states might be implemented as FSMs in inner behaviour modules.
 +
 
 +
==Download xml==
 +
[http://wiki.trapexit.erlang-consulting.com/upload/howto/cascading_behaviours.xml cascading_behaviours.xml]
 +
 
 +
[[Category:HowTo]]

Revision as of 07:35, 11 June 2007

Contents

Author

Vance Shipley

Introduction

Behaviours

Behaviour modules encapsulate some certain functionality for reuse by other modules. The definition of a behaviour includes not only it's exported functions but a list of functions which a callback module must implement. OTP includes several behaviour modules with the most common being gen_server and gen_fsm.

Using gen_fsm

Behaviour

To declare your module as a behaviour callback module you include the -behaviour attribute.


-behaviour(gen_fsm).

Note: All this really does is to enable compilation time checking that you have exported the required callbacks.

Exports

A module which uses the gen_fsm behaviour must export the callbacks which the gen_fsm module calls to handle events. These include handlers for common gen_fsm events as well as the handlers for your user defined states.


-export([init/1, handle_event/3, handle_sync_event/4,
         handle_info/3, terminate/3, code_change/4]).


-export([idle/2, busy/2]).

Startup

To start a process implemented in a module as a gen_fsm behaviour you may call gen_fsm:start/3. In response this function will call the init/1 callback in your module. After your init/1 function returns a result gen_fsm:start_link/3 will return the appropriate result to the calling process. Normally the result is to create a new process where the gen_fsm module is running it's internal main loop function waiting for messages to arrive.


2> {ok, FSM} = gen_fsm:start(simple_fsm, [], []).
{ok,<0.36.0>}

Events

To send an event to your finite state machine process you may call gen_fsm:send_event/2.


2> gen_fsm:send_event(FSM, foo).

ok

The result is that a message is sent to your FSM process tagged so that the gen_fsm module may recognize it as a gen_fsm generated event. When the main loop function in gen_fsm receives this message it will call the state handler callback in your module corresponding to the current state the FSM process is in.

An Example FSM

The Module

Below is a very simple example of a module implemented with a gen_fsm behaviour. In this module we will implement just one state and the only thing it will really do is to be chatty about what is going on.


-module(chatty_fsm).

-export([init/1, handle_event/3, handle_sync_event/4,
         handle_info/3, terminate/3, code_change/4]).
-export([idle/2]).

-behaviour(gen_fsm).

-record(state, {}).

init(Args) ->
    process_flag(trap_exit, true),
    io:fwrite("gen_fsm called ~w:init(~w)~n", [?MODULE, Args]),
    {ok, idle, #state{}}.

idle(Event, StateData) ->
    io:fwrite("gen_fsm called ~w:idle(~w, ~w)~n", 
        [?MODULE, Event, StateData]),
    {next_state, idle, StateData}.

handle_event(Event, StateName, StateData) ->
    io:fwrite("gen_fsm called ~w:handle_event(~w, ~w, ~w)~n",
        [?MODULE, Event, StateName, StateData]),
    {next_state, StateName, StateData}.

handle_sync_event(Event, From, StateName, StateData) ->
    io:fwrite("gen_fsm called ~w:handle_sync_event(~w, ~w, ~w, ~w)~n",
        [?MODULE, Event, From, StateName, StateData]),
    {next_state, StateName, StateData}.

handle_info(Info, StateName, StateData) ->
    io:fwrite("gen_fsm called ~w:handle_info(~w, ~w, ~w)~n",
        [?MODULE, Info, StateName, StateData]),
    {next_state, StateName, StateData}.

terminate(Reason, StateName, StateData) ->

    io:fwrite("gen_fsm called ~w:terminate(~w, ~w, ~w)~n",
        [?MODULE, Reason, StateName, StateData]).

code_change(OldVsn, StateName, StateData, Extra) ->
    io:fwrite("gen_fsm called ~w:code_change(~w, ~w, ~w, ~w)~n",
        [?MODULE, OldVsn, StateName, StateData, Extra]),
    {ok, StateName, StateData}.

Running the Chatty FSM

When we start this module and send it an event as above we will see the functions in our callback module being called.


1> {ok, FSM} = gen_fsm:start(chatty_fsm, [], []).
gen_fsm called chatty_fsm:init([])
{ok,<0.31.0>}


2> gen_fsm:send_event(FSM, foo).

gen_fsm called chatty_fsm:idle(foo, {state})
ok

Creating a New Behaviour

A Chatty FSM Behaviour

Now we may decide that a chatty FSM is a useful thing in a very general way. If we want to make other FSMs chatty we can put this functionality into a behaviour which our FSM modules may behave to. The basic idea is that we will implement the callbacks which the gen_fsm module will call as pass through functions to the callbacks in the user's module. These pass through functions will simply perform the chattyness and then call the FSM module's identical callbacks.

The Module

Note:

It is not suggested that this module performs a useful purpose as it is. There are better solutions to add event tracing including passing the gen_fsm start function the {debug, [trace]} option. The intent is to demonstrate an enhanced behaviour.


-module(chatty_fsm).

%% Export the same API as gen_fsm.
-export([start/3, start/4, start_link/3, start_link/4,
         send_event/2, sync_send_event/2, sync_send_event/3,
         send_all_state_event/2, sync_send_all_state_event/2,
         sync_send_all_state_event/3, reply/2, start_timer/2,
         send_event_after/2,cancel_timer/1]).

%% Export the callbacks gen_fsm expects.
-export([init/1, handle_event/3, handle_sync_event/4,
         handle_info/3, terminate/3, code_change/4]).
-export([state/2]).

%% Define the behaviour's required callbacks.
-export([behaviour_info/1]).

behaviour_info(callbacks) ->

    [{init,1},{handle_event,3},{handle_sync_event,4},
        {handle_info,3}, {terminate,3},{code_change,4}];
behaviour_info(_Other) ->
    undefined.

%% Define this module as a gen_fsm callback module.
-behaviour(gen_fsm).

%% State data record.
-record(state, {module, state, data}).

%% Users will use these start functions instead of gen_fsm's.
%% We add the user's module name to the arguments and call
%% gen_fsm's start function with our module name instead.

start(Mod, Args, Options) ->
    gen_fsm:start(?MODULE, [Mod, Args], Options).

start(Name, Mod, Args, Options) ->
    gen_fsm:start(Name, ?MODULE, [Mod, Args], Options).

start_link(Mod, Args, Options) ->
    gen_fsm:start_link(?MODULE, [Mod, Args], Options).

start_link(Name, Mod, Args, Options) ->
    gen_fsm:start_link(Name, ?MODULE, [Mod, Args], Options).

%% These functions are just pass through to gen_fsm.
%% They are included for completeness only.

send_event(Name, Event) ->
    gen_fsm:send_event(Name, Event).

sync_send_event(Name, Event) ->
    gen_fsm:sync_send_event(Name, Event).

sync_send_event(Name, Event, Timeout) ->
    gen_fsm:sync_send_event(Name, Event, Timeout).

send_all_state_event(Name, Event) ->
    gen_fsm:send_all_state_event(Name, Event).

sync_send_all_state_event(Name, Event) ->
    gen_fsm:sync_send_all_state_event(Name, Event).

sync_send_all_state_event(Name, Event, Timeout) ->

    gen_fsm:sync_send_all_state_event(Name, Event, Timeout).

start_timer(Time, Msg) ->
    gen_fsm:start_timer(Time, Msg).

send_event_after(Time, Event) ->
    gen_fsm:send_event_after(Time, Event).

cancel_timer(Ref) ->
    gen_fsm:cancel_timer(Ref).

reply(Caller, Reply) ->
    gen_fsm:reply(Caller, Reply).

%% Our start function above added the user's module name
%% to the arguments.  We store this in our state data record.

%% After performing our chattyness we run the user's init/1
%% and store the user's next state name and state data in
%% our internal state data record for later reference.
init([Mod, Args]) ->
    io:fwrite("~w:init(~w) -> ", [Mod, Args]),
    case Mod:init(Args) of
        {ok, ExtStateName, ExtStateData} -> 
            io:fwrite("    {ok, ~w, ~w}~n", [ExtStateName, ExtStateData]),
            StateData = #state{module = Mod, state = ExtStateName,
                data = ExtStateData},
            {ok, state, StateData};
        {ok, ExtStateName, ExtStateData, Timeout} ->

            io:fwrite("    {ok, ~w, ~w, ~w}~n",
                [ExtStateName, ExtStateData, Timeout]),
            StateData = #state{module = Mod, state = ExtStateName,
                data = ExtStateData},
            {ok, state, StateData, Timeout};
        {stop, Reason} ->
            io:fwrite("    {stop, ~w}~n", [Reason]),
            {stop, Reason};
        Other ->
            io:fwrite("    ~w~n", [Other]),
            Other
    end.

%% We use only one state handler for this module.
%% After being chatty we look up the user's current state
%% name and call that handler with the current event
%% and the user's state data.

state(Event, StateData) ->
    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:~w(~w, ~w) ->~n",
        [Mod, ExtStateName, Event, ExtStateData]),
    Result = Mod:ExtStateName(Event, ExtStateData),
    handle_result(Result, state, StateData).

%% The other gen_fsm callbacks are handled the same as above.

handle_event(Event, StateName, StateData) ->
    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:handle_event(~w, ~w, ~w) ->~n",
        [Mod, Event, ExtStateName, ExtStateData]),
    Result = Mod:handle_event(Event, ExtStateName, ExtStateData),
    handle_result(Result, StateName, StateData).

handle_sync_event(Event, From, StateName, StateData) ->
    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:handle_sync_event(~w, ~w, ~w, ~w) ->~n",
        [Mod, Event, From, ExtStateName, ExtStateData]),
    Result = Mod:handle_sync_event(Event, From, ExtStateName, ExtStateData),
    handle_result(Result, StateName, StateData).

handle_info(Info, StateName, StateData) ->

    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:handle_info(~w, ~w, ~w) ->~n",
        [Mod, Info, ExtStateName, ExtStateData]),
    Result = Mod:handle_info(Info, ExtStateName, ExtStateData),
    handle_result(Result, StateName, StateData).

terminate(Reason, _StateName, StateData) ->
    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:terminate(~w, ~w, ~w) ->~n",
        [Mod, Reason, ExtStateName, ExtStateData]),
    Mod:terminate(Reason, ExtStateName, ExtStateData).

code_change(OldVsn, StateName, StateData, Extra) ->
    Mod = StateData#state.module,
    ExtStateName = StateData#state.state,
    ExtStateData = StateData#state.data,
    io:fwrite("~w:code_change(~w, ~w, ~w, ~w) ->~n",
        [Mod, OldVsn, ExtStateName, ExtStateData, Extra]),
    case Mod:code_change(OldVsn, ExtStateName, ExtStateData, Extra) of
        {ok, NewExtStateName, NewExtStateData} ->
            io:fwrite("    {ok, ~w, ~w}~n",
                NewExtStateName, NewExtStateData),
            NewStateData = StateData#state{state = NewExtStateName,
                data = NewExtStateData},
            {ok, StateName, NewStateData};
        Else ->
            Else
    end.

%% This function handles the common result set of callbacks.

handle_result({next_state, NewExtStateName, NewExtStateData},
        StateName, StateData) ->
    io:fwrite("    {next_state, ~w, ~w}~n",
        [NewExtStateName, NewExtStateData]),
    NewStateData = StateData#state{state = NewExtStateName,
        data = NewExtStateData},
    {next_state, StateName, NewStateData};
handle_result({next_state, NewExtStateName, NewExtStateData, Timeout},
        StateName, StateData) ->
    io:fwrite("    {next_state, ~w, ~w, ~w}~n",
        [NewExtStateName, NewExtStateData, Timeout]),
    NewStateData = StateData#state{state = NewExtStateName,
        data = NewExtStateData},
    {next_state, StateName, NewStateData, Timeout};
handle_result({reply, Reply, NewExtStateName, NewExtStateData},
        StateName, StateData) ->
    io:fwrite("    {reply, ~w, ~w, ~w}~n",
        [Reply, NewExtStateName, NewExtStateData]),
    NewStateData = StateData#state{state = NewExtStateName,
        data = NewExtStateData},
    {reply, Reply, StateName, NewStateData};
handle_result({reply, Reply, NewExtStateName, NewExtStateData, Timeout},
        StateName, StateData) ->
    io:fwrite("    {reply, ~w, ~w, ~w, ~w}~n",
        [Reply, NewExtStateName, NewExtStateData, Timeout]),
    NewStateData = StateData#state{state = NewExtStateName,
        data = NewExtStateData},
    {reply, Reply, StateName, NewStateData, Timeout};
handle_result({stop, Reason, NewExtStateData}, _StateName, StateData) ->
    io:fwrite("    {stop, ~w, ~w}~n", [Reason, NewExtStateData]),
    NewStateData = StateData#state{data = NewExtStateData},
    {stop, Reason, NewStateData};
handle_result({stop, Reason, Reply, NewExtStateData},
        _StateName, StateData) ->

    io:fwrite("    {stop, ~w, ~w, ~w}~n",
        [Reason, Reply, NewExtStateData]),
    NewStateData = StateData#state{data = NewExtStateData},
    {stop, Reason, Reply, NewStateData};
handle_result(Other, _StateName, _StateData) ->
    io:fwrite("    ~w~n", [Other]),
    Other.

Using the New Behaviour

Module

You write a callback module for chatty_fsm behaviours exactly as you would for gen_fsm.


-behaviour(chatty_fsm).


-export([init/1, handle_event/3, handle_sync_event/4,
         handle_info/3, terminate/3, code_change/4]).

Note: In this example we export an identical interface to the callback

module as imported from gen_fsm. In another example we might have defined

a different list of required callbacks.


-export([idle/2, busy/2]).

Startup

We can now use chatty_fsm anywhere we would use gen_fsm. It exports the same API as gen_fsm and behaves identically only it adds chattyness.


1> {ok, FSM} = chatty_fsm:start(simple_fsm, [], []).
simple_fsm:init([]) ->
    {ok, idle, {state}}
{ok,<0.31.0>}


2> chatty_fsm:send_event(FSM, foo).
simple_fsm:idle(foo, {state}) ->
ok    {next_state, idle, {state}}

You could write a simliar behaviour to do much more interesting things.

Conclusion

Cascading Behaviours

It has been shown that behaviour callback modules may also be behaviour modules. You may create a chain of callbacks of indefinite length.

An interesting example would be a complex finite state machine implemented in several behaviour modules such that the outermost had only a few states. Some of these states might be implemented as FSMs in inner behaviour modules.

Download xml

cascading_behaviours.xml