mirror of
https://github.com/outbackdingo/UltraGrid.git
synced 2026-03-22 08:40:28 +00:00
b88dfa51d7
Undelivered messages are no more rejected. They are saved to the nearest node and delivered after recipient is created. + modules returned from get_module() should not be unlocked any more
145 lines
4.5 KiB
C
145 lines
4.5 KiB
C
/*
|
|
* FILE: module.h
|
|
* AUTHORS: Martin Benes <martinbenesh@gmail.com>
|
|
* Lukas Hejtmanek <xhejtman@ics.muni.cz>
|
|
* Petr Holub <hopet@ics.muni.cz>
|
|
* Milos Liska <xliska@fi.muni.cz>
|
|
* Jiri Matela <matela@ics.muni.cz>
|
|
* Dalibor Matura <255899@mail.muni.cz>
|
|
* Ian Wesley-Smith <iwsmith@cct.lsu.edu>
|
|
*
|
|
* Copyright (c) 2005-2010 CESNET z.s.p.o.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, is permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
*
|
|
* This product includes software developed by CESNET z.s.p.o.
|
|
*
|
|
* 4. Neither the name of the CESNET nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
|
|
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
|
* EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
|
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
#ifndef MODULE_H_
|
|
#define MODULE_H_
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#include "config_win32.h"
|
|
#include "config_unix.h"
|
|
#endif
|
|
|
|
#include "messaging.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define MODULE_MAGIC 0xf1125b44
|
|
|
|
enum module_class {
|
|
MODULE_CLASS_NONE = 0,
|
|
MODULE_CLASS_ROOT,
|
|
MODULE_CLASS_PORT,
|
|
MODULE_CLASS_COMPRESS,
|
|
MODULE_CLASS_DATA,
|
|
MODULE_CLASS_SENDER,
|
|
MODULE_CLASS_RECEIVER,
|
|
MODULE_CLASS_TX,
|
|
MODULE_CLASS_AUDIO,
|
|
MODULE_CLASS_CONTROL,
|
|
MODULE_CLASS_CAPTURE,
|
|
MODULE_CLASS_FILTER,
|
|
};
|
|
|
|
struct module;
|
|
struct simple_linked_list;
|
|
|
|
typedef void (*module_deleter_t)(struct module *);
|
|
|
|
/**
|
|
* @struct module
|
|
* Only members cls, deleter, priv_data and msg_queue may be directly touched
|
|
* by user. The others should be considered private.
|
|
*/
|
|
struct module {
|
|
uint32_t magic;
|
|
pthread_mutex_t lock;
|
|
enum module_class cls;
|
|
struct module *parent;
|
|
struct simple_linked_list *childs;
|
|
module_deleter_t deleter;
|
|
|
|
/**
|
|
* @var msg_callback
|
|
* Module may implement a push method that will respond synchronously to events.
|
|
* If not, message will be enqueued to message queue.
|
|
*/
|
|
msg_callback_t msg_callback;
|
|
struct simple_linked_list *msg_queue;
|
|
|
|
struct simple_linked_list *msg_queue_childs; ///< messages for childern that were not delivered
|
|
|
|
void *priv_data;
|
|
};
|
|
|
|
void module_init_default(struct module *module_data);
|
|
void module_register(struct module *module_data, struct module *parent);
|
|
void module_done(struct module *module_data);
|
|
const char *module_class_name(enum module_class cls);
|
|
void append_message_path(char *buf, int buflen, enum module_class modules[]);
|
|
/**
|
|
* @retval NULL if not found
|
|
* @retval non-NULL pointer to the module
|
|
*/
|
|
struct module *get_module(struct module *root, const char *path);
|
|
|
|
/**
|
|
* IMPORTANT: module given as parameter should be locked within the calling thread.
|
|
*
|
|
* @retval NULL if not found
|
|
* @retval non-NULL pointer to the module
|
|
*/
|
|
struct module *get_matching_child(struct module *node, const char *path);
|
|
|
|
/**
|
|
* Returns pointer to root module.
|
|
*
|
|
* @retval root module
|
|
*/
|
|
struct module *get_root_module(struct module *node);
|
|
|
|
void dump_tree(struct module *root, int indent);
|
|
|
|
#define CAST_MODULE(x) ((struct module *) x)
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|