frame_transfer.h -- document possible exceptions #169
Description
Small documentation update. The documentation for functions in frame_transfer.h should be updated to indicate possible conditions under which exceptions may occur.
In particular, the illegal resource exception can happen for 2 different reasons. The first and most obvious is if the chanends weren't allocated.
Less obvious cause is if there is disagreement between transmitter and receiver about the total number of words to be transferred. The transfer occurs within a transaction, and if either side ends the transaction early, the other side will experience an illegal resource exception.
I already have one case where such a note would have saved someone some time spent debugging, so there will probably be others.