summaryrefslogtreecommitdiff
path: root/include/modules
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2019-06-12 12:42:47 +0100
committerPeter Powell <petpow@saberuk.com>2019-06-12 12:42:47 +0100
commit9b35c4c78cb15bdae0431f1425983bc41150fee5 (patch)
treed1b97d7d808201b28ba4ab564350bbf23a37c335 /include/modules
parent060335168d0d89242ec40f0d42cf27bfb17cf09b (diff)
Add an API for accessing a batch end event.
This is essentially identical to the one for the start event.
Diffstat (limited to 'include/modules')
-rw-r--r--include/modules/ircv3_batch.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/modules/ircv3_batch.h b/include/modules/ircv3_batch.h
index 841554bdb..7708e8d01 100644
--- a/include/modules/ircv3_batch.h
+++ b/include/modules/ircv3_batch.h
@@ -89,6 +89,7 @@ class IRCv3::Batch::Batch
unsigned int bit;
BatchInfo* batchinfo;
ClientProtocol::Message* batchstartmsg;
+ ClientProtocol::Message* batchendmsg;
void Setup(unsigned int b)
{
@@ -158,6 +159,15 @@ class IRCv3::Batch::Batch
*/
ClientProtocol::Message& GetBatchStartMessage() { return *batchstartmsg; }
+ /** Get the batch end client protocol message.
+ * The returned message object can be manipulated to add extra parameters or labels to the message. The first
+ * parameter of the message is the batch reference tag generated by the module providing batch support.
+ * If the batch type string was specified, it will be the second parameter of the message.
+ * May only be called if IsRunning() == true.
+ * @return Mutable batch end client protocol message.
+ */
+ ClientProtocol::Message& GetBatchEndMessage() { return *batchendmsg; }
+
friend class ManagerImpl;
};