Skip to content

Commit 37c8d35

Browse files
committed
Add documentation for control messages
1 parent 58b3182 commit 37c8d35

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

coagent/core/messages.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,25 @@ def decode(cls, raw: RawMessage) -> Message:
5555

5656

5757
class ControlMessage(Message):
58-
"""A control message for controlling the behavior of the corresponding agent.
58+
"""ControlMessage is the base class for all control messages.
59+
60+
A control message is used to control the behavior of an agent. For example,
61+
a `Cancel` message can be sent to an agent to cancel the processing of DATA
62+
messages.
63+
64+
Note that for a given agent, CONTROL messages and DATA messages are processed
65+
in separate coroutines. So the control messages can be processed in a timely
66+
manner without being blocked by the DATA messages.
5967
6068
Any CONTROL message should be a subclass of this class. And any other messages,
6169
inherited from `Message`, are DATA messages.
62-
63-
Note that for a given agent, control messages
6470
"""
6571

6672
pass
6773

6874

6975
class Cancel(ControlMessage):
70-
"""A message to cancel the DATA message processing of an agent."""
76+
"""A control message to cancel the DATA message processing of an agent."""
7177

7278
pass
7379

0 commit comments

Comments
 (0)