729
729
updated internal data.</p>
733
<name>Module:format_status(normal, [PDict, StateData]) -> Status</name>
734
<fsummary>Optional function for providing a term describing the
735
current gen_fsm status.</fsummary>
737
<v>PDict = [{Key, Value}]</v>
738
<v>StateData = term()</v>
739
<v>Status = [term()]</v>
742
<p><em>This callback is optional, so callback modules need not
743
export it. The gen_fsm module provides a default
744
implementation of this function that returns the callback
745
module state data.</em></p>
746
<p>This function is called by a gen_fsm process when one
747
of <seealso marker="sys#get_status/1">sys:get_status/1,2</seealso>
748
is invoked to get the gen_fsm status. A callback module
749
wishing to customise the <c>sys:get_status/1,2</c> return
750
value exports an instance of <c>format_status/2</c> that
751
returns a term describing the current status of the
753
<p><c>PDict</c> is the current value of the gen_fsm's
754
process dictionary.</p>
755
<p><c>StateData</c> is the internal state data of the
757
<p>The function should return <c>Status</c>, a list of one or
758
more terms that customise the details of the current state
759
and status of the gen_fsm.</p>