boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-07-29 20:37:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Tidy up websocket stream javadocs:

Browse Source 
Make clear text()/binary() option is different from got_text()/got_binary().
This commit is contained in:
Benjamin Buch
2018-04-24 12:59:51 +02:00
committed by Vinnie Falco
parent ce2c63ac7a
commit 3d7f1e7303
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -1,3 +1,9 @@
Version 172:
* Tidy up websocket stream javadocs
--------------------------------------------------------------------------------
Version 171:
* Add handler_ptr::has_value

8
include/boost/beast/websocket/stream.hpp
View File

@ -509,7 +509,7 @@ public:
return wr_frag_opt_;
}
/** Set the binary message option.
/** Set the binary message write option.
This controls whether or not outgoing message opcodes
are set to binary or text. The setting is only applied
@ -536,7 +536,7 @@ public:
detail::opcode::text;
}
/// Returns `true` if the binary message option is set.
/// Returns `true` if the binary message write option is set.
bool
binary() const
{
@ -674,7 +674,7 @@ public:
return wr_buf_opt_;
}
/** Set the text message option.
/** Set the text message write option.
This controls whether or not outgoing message opcodes
are set to binary or text. The setting is only applied
@ -701,7 +701,7 @@ public:
detail::opcode::binary;
}
/// Returns `true` if the text message option is set.
/// Returns `true` if the text message write option is set.
bool
text() const
{