Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarified documentation of the "asynchronous" SendMessage() methods.

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23504 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Ingo Weinhold 2008-01-13 22:55:27 +00:00
parent 1beb8bb1ba
commit 69666c9199
1 changed files with 19 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/kits/app/Messenger.cpp
View File

@ -245,10 +245,14 @@ BMessenger::LockTargetWithTimeout(bigtime_t timeout) const
// #pragma mark - Message sending
// SendMessage
/*! \brief Delivers a BMessage synchronously to the messenger's target.
The method does not wait for a reply. The message is sent asynchronously.
/*! \brief Delivers a BMessage synchronously to the messenger's target,
without waiting for a reply.
If the target's message port is full, the method waits indefinitely, until
space becomes available in the port. After delivery the method returns
immediately. It does not wait until the target processes the message or
even sends a reply.
\param command The what field of the message to deliver.
\param replyTo The handler to which a reply to the message shall be sent.
May be \c NULL.
@ -265,12 +269,16 @@ BMessenger::SendMessage(uint32 command, BHandler *replyTo) const
}
// SendMessage
/*! \brief Delivers a BMessage synchronously to the messenger's target.
/*! \brief Delivers a BMessage synchronously to the messenger's target,
without waiting for a reply.
A copy of the supplied message is sent and the caller retains ownership
of \a message.
The method does not wait for a reply. The message is sent asynchronously.
If the target's message port is full, the method waits until space becomes
available in the port or the specified timeout occurs (whichever happens
first). After delivery the method returns immediately. It does not wait
until the target processes the message or even sends a reply.
\param message The message to be sent.
\param replyTo The handler to which a reply to the message shall be sent.
@ -300,12 +308,16 @@ DBG(OUT("BMessenger::SendMessage2() done: %lx\n", error));
}
// SendMessage
/*! \brief Delivers a BMessage synchronously to the messenger's target.
/*! \brief Delivers a BMessage synchronously to the messenger's target,
without waiting for a reply.
A copy of the supplied message is sent and the caller retains ownership
of \a message.
The method does not wait for a reply. The message is sent asynchronously.
If the target's message port is full, the method waits until space becomes
available in the port or the specified timeout occurs (whichever happens
first). After delivery the method returns immediately. It does not wait
until the target processes the message or even sends a reply.
\param message The message to be sent.
\param replyTo A messenger specifying the target for a reply to \a message.