Added protocols for the message runner communication.

git-svn-id: file:///srv/svn/repos/haiku/trunk/current@1499 a95241bf-73f2-0310-859d-f6bbb57e9c96

docs/develop/servers/registrar/Protocols

@@ -65,10 +65,6 @@ Roster Requests
 ---------------
 
 app registration (BRoster::AddApplication())
-BRoster::AddApplication(const char *mimeSig, const entry_ref *ref,
-						uint32 flags, team_id team, thread_id thread,
-						port_id port, bool fullReg, uint32 *_token,
-						team_id *otherTeam) const
 
 target:		roster
 message:	B_REG_ADD_APP
@@ -550,13 +546,118 @@ target:		thread manager/mime manager (MIMEManager::fThreadManager/BRoster::fMime
 message:	B_REG_MIME_UPDATE_THREAD_FINISHED
 reply:		none (message should be sent asynchronously)
 
+-----------------------------------------------------------------------
 
+message runner registration (BMessageRunner::InitData())
 
+target:		roster
+message:	B_REG_REGISTER_MESSAGE_RUNNER
+			"team":					B_INT32_TYPE
+			"target":				B_MESSENGER_TYPE
+			"message":				B_MESSAGE_TYPE
+			"interval":				B_INT64_TYPE
+			"count":				B_INT32_TYPE
+			"reply_target":			B_MESSENGER_TYPE
+reply:		standard success
+			"token":				B_INT32_TYPE
+on error:	- B_NO_REPLY (fatal)
+			- standard error
 
+message fields:
+- "team": ID of the team owning the BMessageRunner (team_id).
+- "target": The message target.
+- "message": The message to be sent to the target.
+- "interval": Period of time before the first message is sent and between
+			  messages (if more than one shall be sent) in microseconds.
+- "count": Specifies how many times the message shall be sent.
+		   A value less than 0 for an unlimited number of repetitions.
+- "reply_target": Target replies to the delivered message(s) shall be sent to.
 
+reply fields:
+- "token": Unique token identifying the message runner.
 
+error reply fields:
+- "error":
+  - B_BAD_VALUE: A request message field is missing or contains an
+    invalid value.
+  - ...
 
+-----------------------------------------------------------------------
 
+message runner unregistration (BMessageRunner::~BMessageRunner())
 
+target:		roster
+message:	B_REG_UNREGISTER_MESSAGE_RUNNER
+			"token":				B_INT32_TYPE
+reply:		standard success
+on error:	- B_NO_REPLY (fatal)
+			- standard error
 
+message fields:
+- "token": Unique token identifying the message runner. Returned by the
+		   B_REG_REGISTER_MESSAGE_RUNNER request.
+
+error reply fields:
+- "error":
+  - B_BAD_VALUE: A request message field is missing or contains an
+    invalid value.
+  - ...
+
+-----------------------------------------------------------------------
+
+set message runner parameters (BMessageRunner::SetParams())
+
+target:		roster
+message:	B_REG_SET_MESSAGE_RUNNER_PARAMS
+			"token":				B_INT32_TYPE
+			[ "interval":			B_INT64_TYPE ]
+			[ "count":				B_INT32_TYPE ]
+reply:		standard success
+on error:	- B_NO_REPLY (fatal)
+			- standard error
+
+message fields:
+- "token": Unique token identifying the message runner. Returned by the
+		   B_REG_REGISTER_MESSAGE_RUNNER request.
+- "interval": Period of time before the first message is sent and between
+			  messages (if more than one shall be sent) in microseconds.
+- "count": Specifies how many times the message shall be sent.
+		   A value less than 0 for an unlimited number of repetitions.
+
+error reply fields:
+- "error":
+  - B_BAD_VALUE: A request message field is missing or contains an
+    invalid value.
+  - ...
+
+-----------------------------------------------------------------------
+
+get message runner info (BMessageRunner::InitData())
+
+target:		roster
+message:	B_REG_GET_MESSAGE_RUNNER_INFO
+			"token":				B_INT32_TYPE
+reply:		standard success
+			"interval":				B_INT64_TYPE
+			"count":				B_INT32_TYPE
+on error:	- B_NO_REPLY (fatal)
+			- standard error
+
+message fields:
+- "token": Unique token identifying the message runner. Returned by the
+		   B_REG_REGISTER_MESSAGE_RUNNER request.
+
+reply fields:
+- "interval": Period of time before the first message is sent and between
+			  messages (if more than one shall be sent) in microseconds.
+- "count": Specifies how many times the message still has to be sent.
+		   A value less than 0 for an unlimited number of repetitions.
+
+error reply fields:
+- "error":
+  - B_BAD_VALUE: A request message field is missing or contains an
+    invalid value.
+  - ...
+
+-----------------------------------------------------------------------