Skip to content

Commit 3b87e27

Browse files
committed
docs: document that events are broadcasted to all event emitters
Delta Chat for iOS already relies on this behavior, so it cannot be practically changed.
1 parent 24b21c0 commit 3b87e27

1 file changed

Lines changed: 11 additions & 26 deletions

File tree

deltachat-ffi/deltachat.h

Lines changed: 11 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -364,18 +364,14 @@ uint32_t dc_get_id (dc_context_t* context);
364364
* To get these events, you have to create an event emitter using this function
365365
* and call dc_get_next_event() on the emitter.
366366
*
367+
* Events are broadcasted to all existing event emitters.
368+
* Events emitted before creation of event emitter
369+
* are not available to event emitter.
370+
*
367371
* @memberof dc_context_t
368372
* @param context The context object as created by dc_context_new().
369373
* @return Returns the event emitter, NULL on errors.
370374
* Must be freed using dc_event_emitter_unref() after usage.
371-
*
372-
* Note: Use only one event emitter per context.
373-
* The result of having multiple event emitters is unspecified.
374-
* Currently events are broadcasted to all existing event emitters,
375-
* but previous versions delivered events to only one event emitter
376-
* and this behavior may change again in the future.
377-
* Events emitted before creation of event emitter
378-
* may or may not be available to event emitter.
379375
*/
380376
dc_event_emitter_t* dc_get_event_emitter(dc_context_t* context);
381377

@@ -3323,18 +3319,14 @@ void dc_accounts_set_push_device_token (dc_accounts_t* accounts, const
33233319
* This is similar to dc_get_event_emitter(), which, however,
33243320
* must not be called for accounts handled by the account manager.
33253321
*
3322+
* Events are broadcasted to all existing event emitters.
3323+
* Events emitted before creation of event emitter
3324+
* are not available to event emitter.
3325+
*
33263326
* @memberof dc_accounts_t
33273327
* @param accounts The account manager as created by dc_accounts_new().
33283328
* @return Returns the event emitter, NULL on errors.
33293329
* Must be freed using dc_event_emitter_unref() after usage.
3330-
*
3331-
* Note: Use only one event emitter per account manager.
3332-
* The result of having multiple event emitters is unspecified.
3333-
* Currently events are broadcasted to all existing event emitters,
3334-
* but previous versions delivered events to only one event emitter
3335-
* and this behavior may change again in the future.
3336-
* Events emitted before creation of event emitter
3337-
* are not available to event emitter.
33383330
*/
33393331
dc_event_emitter_t* dc_accounts_get_event_emitter (dc_accounts_t* accounts);
33403332

@@ -5979,21 +5971,14 @@ void dc_event_channel_unref(dc_event_channel_t* event_channel);
59795971
* To get these events, you have to create an event emitter using this function
59805972
* and call dc_get_next_event() on the emitter.
59815973
*
5982-
* This is similar to dc_get_event_emitter(), which, however,
5983-
* must not be called for accounts handled by the account manager.
5974+
* Events are broadcasted to all existing event emitters.
5975+
* Events emitted before creation of event emitter
5976+
* are not available to event emitter.
59845977
*
59855978
* @memberof dc_event_channel_t
59865979
* @param The event channel.
59875980
* @return Returns the event emitter, NULL on errors.
59885981
* Must be freed using dc_event_emitter_unref() after usage.
5989-
*
5990-
* Note: Use only one event emitter per account manager / event channel.
5991-
* The result of having multiple event emitters is unspecified.
5992-
* Currently events are broadcasted to all existing event emitters,
5993-
* but previous versions delivered events to only one event emitter
5994-
* and this behavior may change again in the future.
5995-
* Events emitted before creation of event emitter
5996-
* are not available to event emitter.
59975982
*/
59985983
dc_event_emitter_t* dc_event_channel_get_event_emitter(dc_event_channel_t* event_channel);
59995984

0 commit comments

Comments
 (0)