Commit 3d440507 authored by Constantin Rack's avatar Constantin Rack

Merge pull request #1317 from topher200/master

documentation clarification on pipe::write failure
parents be23e699 708298ea
......@@ -86,12 +86,14 @@ namespace zmq
// Reads a message to the underlying pipe.
bool read (msg_t *msg_);
// Checks whether messages can be written to the pipe. If writing
// the message would cause high watermark the function returns false.
// Checks whether messages can be written to the pipe. If the pipe is
// closed or if writing the message would cause high watermark the
// function returns false.
bool check_write ();
// Writes a message to the underlying pipe. Returns false if the
// message cannot be written because high watermark was reached.
// message does not pass check_write. If false, the message object
// retains ownership of its message buffer.
bool write (msg_t *msg_);
// Remove unfinished parts of the outbound message from the pipe.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment