Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / Languages / VC10.0

Getting in the RAII

3.80/5 (4 votes)
17 Jun 2010CPOL 10.7K  
Looking at a simple MIDI handle wrapping class

One of Web Biscuit's long-term secret projects is the MidiWrapper, an object-oriented interface for MIDI. A cornerstone of MIDI operations is the HMIDIOUT handle, which requires opening before use, and closing when we're done with it.

This can be done in a RAII class. RAII stands for Resource Acquisition is Initialization, not the snappiest acronym in the whole wide world and not that self explanatory. Basically, we use the guarantee that creating an object always calls a constructor and eventually, a destructor. Played smartly, these two opposing calls can give us automatic Open/Close functionality.

Here's our class:

C++
class CMidiOut
{
public:
    CMidiOut() {}
    ~CMidiOut() {}
private:
    HMIDIOUT m_hMidiOutHandle;
};

We could add Open and Close as public members, but there really is no need. We don't want to burden the creator of our object with things they might forget to do. So let's do it for them:

C++
class CMidiOut
{
public:
    CMidiOut()  :
        m_hMidiOutHandle(nullptr)
    {
        midiOutOpen(
            &m_hMidiOutHandle,  	// Handle
            MIDI_MAPPER,  		// Default device
            NULL,  		// No callback
            NULL,  		// No callback parameters
            CALLBACK_NULL);  	// Flags
    }
    ~CMidiOut()
    {
        if(m_hMidiOutHandle != nullptr)
        {
            midiOutClose(m_hMidiOutHandle);
            m_hMidiOutHandle = nullptr;
        }
    }
private:
    HMIDIOUT m_hMidiOutHandle;
}; 

This is very cute. For a full solution, you'll want an accessor to your handle, and you'll need to prevent or handle copying of your class. These are all exciting subjects we can discuss next time.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)