Skip to content

Commit 7fb5eb2

Browse files
committed
Update function signatures for sending and receving messages in Processor Plugins
1 parent c2034d2 commit 7fb5eb2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

source/Developer-Guide/Open-Ephys-Plugin-API/Processor-Plugins.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -231,26 +231,26 @@ Sending and receiving messages
231231

232232
While acquisition is not active, plugins can respond to **configuration messages** and send **status messages**:
233233

234-
.. function:: void handleConfigMessage(String message)
234+
.. function:: void handleConfigMessage(const String& message)
235235

236236
Allows a plugin to respond to a configuration message (usually received via the :code:`OpenEphysHTTPServer`). This makes it possible to configure a plugin's settings remotely. Config messages are ignored if acquisition is active.
237237

238-
:param message: The content of the configuration message. There are no restrictions on how this string is formatted; each plugin is responsible for parsing this message in the appropriate way.
238+
:param message: The content of the configuration message. There are no restrictions on how this string is formatted; each plugin is responsible for parsing this message in the appropriate way.
239239

240-
.. function:: void CoreServices::sendStatusMessage(String message)
240+
.. function:: void CoreServices::sendStatusMessage(const String& message)
241241

242242
Displays a message to the user in the GUI's Message Center.
243243

244-
:param message: The message to display.
244+
:param message: The message to display.
245245

246246
While acquisition is active, plugins can respond to and send **broadcast messages**:
247247

248-
.. function:: void handleBroadcastMessage(String message)
248+
.. function:: void handleBroadcastMessage(const String& message, const int64 systemTimeMillis)
249249

250250
Allows a plugin to respond to an event that carries a text value, which is broadcast throughout the signal chain during acquisition. These messages can be used to pass information backwards through the signal chain, e.g. to trigger an output based on events that are generated downstream.
251251

252252
:param message: The content of the broadcast message. There are no restrictions on how this string is formatted; each plugin is responsible for parsing this message in the appropriate way.
253-
253+
:param systemTimeMillis: The system time (in milliseconds) at which this message was sent. This can be used to synchronize the message with other data in the signal chain.
254254

255255
.. function:: void broadcastMessage(String message)
256256

0 commit comments

Comments
 (0)