docs: lws_callback_all_protocol: fix cut-n-paste error and explain it is probably...
authorAndy Green <andy@warmcat.com>
Tue, 14 Mar 2017 23:28:51 +0000 (07:28 +0800)
committerAndy Green <andy@warmcat.com>
Tue, 14 Mar 2017 23:28:51 +0000 (07:28 +0800)
lib/libwebsockets.h

index 1f7cf6f..751206d 100644 (file)
@@ -3605,8 +3605,12 @@ lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
  * \param reason:      Callback reason index
  *
  * - Which:  connections using this protocol on ALL VHOSTS
- * - When:   when the individual connection becomes writeable
+ * - When:   before returning
  * - What:   reason
+ *
+ * This isn't normally what you want... normally any update of connection-
+ * specific information can wait until a network-related callback like rx,
+ * writable, or close.
  */
 LWS_VISIBLE LWS_EXTERN int
 lws_callback_all_protocol(struct lws_context *context,