From 43c317ef4c04102f5f9983437c999261381f0427 Mon Sep 17 00:00:00 2001 From: Evelyn Date: Fri, 22 Jul 2016 14:36:13 +0100 Subject: [PATCH] Update mg_broadcast.md --- docs/c-api/net.h/mg_broadcast.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/c-api/net.h/mg_broadcast.md b/docs/c-api/net.h/mg_broadcast.md index 94fceb8f..4eda7f3c 100644 --- a/docs/c-api/net.h/mg_broadcast.md +++ b/docs/c-api/net.h/mg_broadcast.md @@ -6,14 +6,14 @@ signature: | void mg_broadcast(struct mg_mgr *, mg_event_handler_t func, void *, size_t); --- -Pass a message of a given length to all connections. +Passes a message of a given length to all connections. Must be called from a thread that does NOT call `mg_mgr_poll()`. Note that `mg_broadcast()` is the only function that can be, and must be, called from a different (non-IO) thread. `func` callback function will be called by the IO thread for each -connection. When called, event would be `MG_EV_POLL`, and message will -be passed as `ev_data` pointer. Maximum message size is capped +connection. When called, the event will be `MG_EV_POLL`, and a message will +be passed as the `ev_data` pointer. Maximum message size is capped by `MG_CTL_MSG_MESSAGE_SIZE` which is set to 8192 bytes.