adds documentation notes about when fatal_error and eof methods showed up

This commit is contained in:
Peter Thorson
2013-09-28 07:56:03 -05:00
parent 3035c8dc0a
commit de6d15c9fc

View File

@@ -162,6 +162,8 @@ public:
/**
* Signals to the transport that data stream being read has reached EOF and
* that no more bytes may be read or written to/from the transport.
*
* @since 0.3.0-alpha4
*/
void eof() {
// this serializes calls to external read.
@@ -177,6 +179,8 @@ public:
/**
* Signals to the transport that a fatal data stream error has occurred and
* that no more bytes may be read or written to/from the transport.
*
* @since 0.3.0-alpha4
*/
void fatal_error() {
// this serializes calls to external read.