1 /*************************************************************************/
2 /*  message_queue.h                                                      */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md)    */
10 /*                                                                       */
11 /* Permission is hereby granted, free of charge, to any person obtaining */
12 /* a copy of this software and associated documentation files (the       */
13 /* "Software"), to deal in the Software without restriction, including   */
14 /* without limitation the rights to use, copy, modify, merge, publish,   */
15 /* distribute, sublicense, and/or sell copies of the Software, and to    */
16 /* permit persons to whom the Software is furnished to do so, subject to */
17 /* the following conditions:                                             */
18 /*                                                                       */
19 /* The above copyright notice and this permission notice shall be        */
20 /* included in all copies or substantial portions of the Software.       */
21 /*                                                                       */
22 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
23 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
24 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
25 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
26 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
27 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
28 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
29 /*************************************************************************/
30 #ifndef MESSAGE_QUEUE_H
31 #define MESSAGE_QUEUE_H
32 
33 #include "object.h"
34 #include "os/mutex.h"
35 #include "os/thread_safe.h"
36 class MessageQueue {
37 
38 	_THREAD_SAFE_CLASS_
39 
40 	enum {
41 
42 		DEFAULT_QUEUE_SIZE_KB = 1024
43 	};
44 
45 	Mutex *mutex;
46 
47 	enum {
48 		TYPE_CALL,
49 		TYPE_NOTIFICATION,
50 		TYPE_SET,
51 		FLAG_SHOW_ERROR = 1 << 14,
52 		FLAG_MASK = FLAG_SHOW_ERROR - 1
53 
54 	};
55 
56 	struct Message {
57 
58 		ObjectID instance_ID;
59 		StringName target;
60 		int16_t type;
61 		union {
62 			int16_t notification;
63 			int16_t args;
64 		};
65 	};
66 
67 	uint8_t *buffer;
68 	uint32_t buffer_end;
69 	uint32_t buffer_max_used;
70 	uint32_t buffer_size;
71 
72 	void _call_function(Object *p_target, const StringName &p_func, const Variant *p_args, int p_argcount, bool p_show_error);
73 
74 	static MessageQueue *singleton;
75 
76 public:
77 	static MessageQueue *get_singleton();
78 
79 	Error push_call(ObjectID p_id, const StringName &p_method, const Variant **p_args, int p_argcount, bool p_show_error = false);
80 	Error push_call(ObjectID p_id, const StringName &p_method, VARIANT_ARG_LIST);
81 	Error push_notification(ObjectID p_id, int p_notification);
82 	Error push_set(ObjectID p_id, const StringName &p_prop, const Variant &p_value);
83 
84 	Error push_call(Object *p_object, const StringName &p_method, VARIANT_ARG_LIST);
85 	Error push_notification(Object *p_object, int p_notification);
86 	Error push_set(Object *p_object, const StringName &p_prop, const Variant &p_value);
87 
88 	bool print();
89 	void statistics();
90 	void flush();
91 
92 	int get_max_buffer_usage() const;
93 
94 	MessageQueue();
95 	~MessageQueue();
96 };
97 
98 #endif // MESSAGE_QUEUE_H
99