blob: f945e7e726f80c39ee99d05a99c628b1fb5c33c5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/*
* Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The EventMessenger is the system that messages events between
* producers and consumers.
*
* Events are delivered in a deferred event cycle to avoid event callbacks
* firing when the event generator is still running.
*/
#ifndef messenger_h
#define messenger_h
#include <src/core/dispatcher.h>
#include <src/messenger/messengerRecipient.h>
#include <src/messenger/missive.h>
struct messenger;
typedef struct messenger Messenger;
/**
* @function eventmessenger_Create
* @abstract Creates an event notification system
* @discussion
* Typically there's only one of these managed by forwarder.
*
* @param dispatcher is the event dispatcher to use to schedule events.
*/
Messenger *messenger_Create(Dispatcher *dispatcher);
/**
* @function eventMessenger_Destroy
* @abstract Destroys the messenger system, no notification is sent
*/
void messenger_Destroy(Messenger **messengerPtr);
/**
* @function eventMessenger_Send
* @abstract Send an event message, takes ownership of the event memory
*/
void messenger_Send(Messenger *messenger, Missive *missive);
/**
* @function eventMessenger_Register
* @abstract Receive all event messages
*/
void messenger_Register(Messenger *messenger,
const MessengerRecipient *recipient);
/**
* @function eventMessenger_Unregister
* @abstract Stop receiving event messages
*/
void messenger_Unregister(Messenger *messenger,
const MessengerRecipient *recipient);
#endif // messenger_h
|
