Home > Articles > Programming > Windows Programming

Using Object Oriented State Machines in .NET

  • Print
  • + Share This
Maybe you haven't worked with state machines since your college computer science courses. Jon Shemitz offers a reason to dust off the technique with .NET: object-oriented state machines can be easier to read and debug than their
Like this article? We recommend

State machines are old technology, but they have many uses even for modern programmers. Probably the most common reason to build a state machine on .NET is emulating coroutines in recursive IEnumerator, such as one that must return a FileSystemInfo for every file and directory under a starting directory. Since this only takes three states, that's exactly what the sample code for this article ( StateMachines.zip ) can do. In Whidbey, iterators will eliminate the need to emulate coroutines, but Whidbey may still be as much as a year out—and even when Whidbey arrives, there will still be uses for state machines in .NET programming.

The basic idea is that you execute a state machine iteratively, when you need to extract the next value from an input stream, or when a new input comes in. The Current state controls which code is executed on each iteration; the Current state's handler may or may not change the Current state. If the Current state handler doesn't change the Current state, the same handler is invoked each time the state machine is iterated, until something changes.

The canonical way to implement a state machine is via an enum containing the name of every state, and a giant switch statement containing the handler for each enum. This compiles to a nice efficient jump table, but it's hard to maintain. When you add a new state, you have to change both the enum and the switch statement; plus, tracing execution means lots of jumping around the switch statement.

After writing an IEnumerator as an enum and switch state machine, I got to wondering: if an object is just a state packet, could you swap state by changing the CurrentState object, instead of the CurrentEnum value? Each state's handler would stand by itself as a standard method, which is easier to read than a long switch statement. Adding a new state just means adding a new class, which is easier than editing both the enum and the switch. And when a handler changes the CurrentState, you can use F12 to jump to the implementation of the next state, which is easier than having to find it by hand in a long switch statement.

The interface between IEnumerator and a state machine is pretty obvious: Reset() sets CurrentState to an initial state. MoveNext() iterates the state machine, either setting an internal CurrentValue field and returning true, or returning false to indicate that there are no (more) items. And the Current property exposes the internal CurrentValue field.

Each state handler needs to be able to change the enumerator's private CurrentState field. That is, we need a circular reference where the state machine refers to the current state object, and the state handler has a reference back to the state machine.

A simple implementation gives the Enumerator object a private reference to a CurrentState object; each CurrentState object is an instance of a private class, nested within the Enumerator class, that has a reference to the Enumerator instance so that it can change the CurrentState.

The only problem, here, is that each different enumeration needs to build the state machine infrastructure all over again: reusability demands looser coupling.

Similarly, you could implement the current state handler as a virtual method, but this requires that all state classes descend from a common, abstract ancestor. While this is probably fine in at least 99.9% of all cases, using interfaces presents a bit more flexibility.

Thus, StateMachines.cs includes an abstract Enumerator class which expects state handler classes to support IStateHandler:

public interface IStateHandler 
{
	bool MoveNext(IStateMachine StateMachine) ;
}

The abstract Enumerator class supports IEnumerator via a generic state machine:

private IStateHandler  CurrentState;
private object CurrentValue ;

protected abstract IStateHandler  StartState() ;

public void Reset()
{
  CurrentState = /*abstract*/ StartState();
  CurrentValue  = null;
}

public object Current
{  
  get  {  return CurrentValue ;  }  
}

public bool MoveNext()
{
  return CurrentState.MoveNext(this);
}

Reset() sets an initial state handler, and MoveNext() iterates the state machine by calling the current state's handler. Now, sometimes you have to cycle the state machine through a few iterations before you get to an output state. For example, a given directory may have subdirectories but no files, or you may have just processed the last subdirectory of a last subdirectory, and so on. In an enum and switch implementation, this might be done with code like this:

bool Deliver = false;
do
  switch (CurrentState)
  {
  }
while (! Deliver);

This loops until a state handler sets Deliver to true.

In my loosely-coupled, object-oriented implementation, the abstract Enumerator class supports the IStateMachine interface, which provides state classes with a couple of utilities: bool Yield() sets the internal CurrentValue (and, optionally, the CurrentState) and returns true; bool Recurse() sets the CurrentState, and recursively returns whatever the new state's IMoveNext implementation returns:

bool IStateMachine.Yield(object NewValue)
{
  CurrentValue  = NewValue;
  return true;
}

bool IStateMachine.Yield(object NewValue, IStateHandler  NextState)
{
  CurrentValue  = NewValue;
  CurrentState = NextState;
  return true;
}

bool IStateMachine.Recurse(IStateHandler NextState)
{
  if (NextState == null)
    return false; // no next state, no next item
  CurrentState = NextState;
  return NextState.MoveNext(this); // recurse
}

That is, return Yield() sets a new CurrentValue and suspends the state machine; return Recurse() passes control to a new state handler (which may itself either Yield() or Recurse()) and passes the result back out to the "outer process."

The actual state classes are nested two deep in the AllFiles class, which implements IEnumerable by returning a new instance of the nested private class DirectoryEnumerator: Enumerator.DirectoryEnumerator overrides StartState() and contains the actual state handler classes, ShowDirectory, ShowFiles, and ShowSubdirectories.

The start state is ShowDirectory, with a null next state, and the DirectoryInfo passed to the AllFiles constructor:

protected override IStateHandler  StartState()
{
  return new ShowDirectory(null, RootDirectory);
}

Thus, calling Enumerator.MoveNext() after a Reset() calls the ShowDirectory state handler:

public bool MoveNext(IStateMachine StateMachine)
{
  IStateHandler  subdirectories = 
    new ShowSubdirectories(NextState, Directory.GetDirectories());
  IStateHandler  files = 
    new ShowFiles(subdirectories, Directory.GetFiles());


  // set Current to this directory; next time, scan files
  return StateMachine.Yield(Directory, files);
}

This first creates a ShowSubdirectories state that "returns" to the ShowDirectory state's NextState. Then, it creates a ShowFiles state that "forwards" to the ShowSubdirectories state. Finally, it sets the CurrentValue to Directory and returns true.

The ShowFiles constructor calls GetEnumerator() on its second, IEnumerable parameter, and ShowFiles.MoveNext() either steps this array enumerator or passes control to the next, ShowSubdirectories state:

public bool MoveNext(IStateMachine StateMachine)
{
  if (ArrayEnumerator.MoveNext())
    return StateMachine.Yield((FileInfo) ArrayEnumerator.Current);
  else
    return StateMachine.Recurse(NextState);
}

The ShowSubdirectories constructor similarly calls GetEnumerator() on its second, IEnumerable parameter, and ShowSubdirectories.MoveNext() either steps this array enumerator and recursively sets the NewDirectory state to iterate the subdirectory, or "returns" to the parent directory state, which may be null:

public bool MoveNext(IStateMachine StateMachine)
{
  if (ArrayEnumerator.MoveNext())
    // at least one more subdirectory - recurse
    return StateMachine.Recurse(
      new ShowDirectory(this, 
        (DirectoryInfo) ArrayEnumerator.Current));
  else
    // no (more) subdirectories - pop
    return StateMachine.Recurse(NextState);
}

As you can see, ShowSubdirectories is a strictly internal state that never yields control to the "outer process." It either invokes the ShowDirectory state with itself as the parent state, or it returns control to its own parent.

State machines often require more state data than simply which handler to invoke next. For example, the whole point of IEnumerator is the CurrentValue. In a one-off state machine, state handlers might be nested within the class that implements IEnumerator, and can thus freely access private fields and private properties. In a more loosely-coupled implementation, you can do as I've done, and build access to the extra state variables into the handlers' interface to the state machine.

One thing you don't need to do is to build an explicit state stack, as you often need to do in an an enum and switch implementation. Each state class contains a NextState field, which can be a "return address" (as in the ShowDirectory and ShowSubdirectories states) or a "forwarding address" (as in the ShowFiles state). In effect, the state classes maintain a sort of distributed stack, in the linked list of ShowDirectory state objects.

Overall, I find that object-oriented state machines are a lot easier to read and debug than their enum and switch equivalents. While there's a certain amount of programming overhead involved in creating a class for each state, this seems to me to be roughly comparable to the amount of overhead involved in updating both an enum and a switch.

While implementing a state machine via state objects is a bit more expensive than using a switch statement, I don't think this matters all that much since most uses of state machines focus on their ability to maintain context across multiple invocations, and speed is not a primary concern.

Jon Shemitz is an independent developer and author in Santa Cruz, California.

Download the code from this article.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020