I have a class that represents a data stream, it basically
reads or writes into a file, but first the data are being encrypted/decrypted and there is also an underlying codec object that handles the media being accessed.
I’m trying to write this class in a RAII way and I’d like a clean, nice, usable design.
What bothers me is that right now there is a lot of work being done in the constructor.
Before the object’s I/O routines can be safely used, first of all the codec needs to initialized (this isn’t very demanding), but then a key is taken into account and crypto and other things are intialized – these require some analysis of the media which takes quite a lot of computation.
Right now I’m doing all this in the constructor, which makes it take a long time. I’m thinking of moving the crypto init stuff (most work) out of the ctor into a separate method (say, Stream::auth(key)), but then again, this would move some responsibility to the user of the class, as they’d be required to run auth() before they call any I/O ops. This also means I’d have to place a check in the I/O calls to verify that auth() had been called.
What do you think is a good design?
P.S. I did read similar question but I wasn’t really able to apply the answers on this case. They’re mostly like “It depens”… :-/
Thanks
The only truly golden unbreakable rule is that the class must be in a valid, consistent, state after the constructor has executed.
You can choose to design the class so that it is in some kind of “empty”/”inactive” state after the constructor has run, or you can put it directly into the “active” state that it is intended to be in.
Generally, it should be preferred to have the constructor construct your class. Usually, you wouldn’t consider a class fully “constructed”, until it’s actually ready to be used, but exceptions do exist.
However, keep in mind that in RAII, one of the key ideas is that the class shouldn’t exist unless it is ready, initalized and usable. That’s why its destructor does the cleanup, and that’s why its constructor should do the setup.
Again, exceptions do exist (for example, some RAII objects allow you to release the resource and perform cleanup early, and then have the destructor do nothing.)
So at the end of the day, it depends, and you’ll have to use your own judgment.
Think of it in terms of invariants. What can I rely on if I’m given an instance of your class? The more I can safely assume about it, the easier it is to use. If it might be ready to use, and might be in some “constructed, but not initialized” state, and might be in a “cleaned up but not destroyed” state, then using it quickly becomes painful.
On the other hand, if it guarantees that “if the object exists, it can be used as-is”, then I’ll know that I can use it without worrying about what was done to it before.
It sounds like your problem is that you’re doing too much in the constructor.
What if you split the work up into multiple smaller classes? Have the codec be initialized separately, then I can simply pass the already-initialized codec to your constructor. And all the authentication and cryptography stuff and whatnot could possibly be moved out into separate objects as well, and then simply passed to “this” constructor once they’re ready.
Then the remaining constructor doesn’t have to do everything from scratch, but can start from a handful of helper objects which are already initialized and ready to be used, so it just has to connect the dots.