mirror of
https://gitlab.xiph.org/xiph/icecast-server.git
synced 2024-06-23 06:25:24 +00:00
134 lines
3.5 KiB
C
134 lines
3.5 KiB
C
/* Icecast
|
|
*
|
|
* This program is distributed under the GNU General Public License, version 2.
|
|
* A copy of this license is included with this source.
|
|
*
|
|
* Copyright 2014-2023, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>,
|
|
*/
|
|
|
|
#ifndef __EVENT_H__
|
|
#define __EVENT_H__
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include <libxml/xmlmemory.h>
|
|
#include <libxml/parser.h>
|
|
#include <libxml/tree.h>
|
|
|
|
#include "icecasttypes.h"
|
|
#include <igloo/error.h>
|
|
#include <igloo/typedef.h>
|
|
#include <igloo/ro.h>
|
|
|
|
#include "common/thread/thread.h"
|
|
|
|
/* implemented */
|
|
#define EVENT_TYPE_LOG "log"
|
|
#define EVENT_TYPE_EXEC "exec"
|
|
#define EVENT_TYPE_URL "url"
|
|
|
|
#define MAX_REGLISTS_PER_EVENT 8
|
|
|
|
typedef enum {
|
|
/* special keys */
|
|
EVENT_EXTRA_LIST_END,
|
|
EVENT_EXTRA_CLIENT,
|
|
EVENT_EXTRA_SOURCE,
|
|
/* real keys */
|
|
EVENT_EXTRA_KEY_URI,
|
|
EVENT_EXTRA_KEY_CONNECTION_IP,
|
|
EVENT_EXTRA_KEY_CLIENT_ROLE,
|
|
EVENT_EXTRA_KEY_CLIENT_USERNAME,
|
|
EVENT_EXTRA_KEY_CLIENT_USERAGENT,
|
|
EVENT_EXTRA_KEY_SOURCE_MEDIA_TYPE,
|
|
EVENT_EXTRA_KEY_SOURCE_INSTANCE_UUID,
|
|
EVENT_EXTRA_KEY_DUMPFILE_FILENAME,
|
|
} event_extra_key_t;
|
|
|
|
typedef struct {
|
|
event_extra_key_t key;
|
|
const char *value;
|
|
} event_extra_entry_t;
|
|
|
|
igloo_RO_FORWARD_TYPE(event_t);
|
|
igloo_RO_FORWARD_TYPE(event_registration_t);
|
|
|
|
/* this has no lock member to protect multiple accesses as every non-readonly access is within event.c
|
|
* and is protected by global lock or on the same thread anyway.
|
|
*/
|
|
struct event_tag {
|
|
igloo_ro_full_t __parent;
|
|
/* reference to next element in chain */
|
|
event_t *next;
|
|
|
|
/* event_registration lists.
|
|
* They are referenced here to avoid the need to access
|
|
* config and global client list each time an event is emitted.
|
|
*/
|
|
event_registration_t *reglist[MAX_REGLISTS_PER_EVENT];
|
|
|
|
/* trigger name */
|
|
char *trigger;
|
|
|
|
/* from client */
|
|
bool client_data;
|
|
unsigned long connection_id; /* from client->con->id */
|
|
time_t connection_time; /* from client->con->con_time */
|
|
admin_command_id_t client_admin_command; /* from client->admin_command */
|
|
/* extra */
|
|
size_t extra_size;
|
|
size_t extra_fill;
|
|
event_extra_entry_t *extra_entries;
|
|
};
|
|
|
|
struct event_registration_tag {
|
|
igloo_ro_full_t __parent;
|
|
|
|
/* reference to next element in chain */
|
|
event_registration_t *next;
|
|
|
|
/* protection */
|
|
mutex_t lock;
|
|
|
|
/* type of event */
|
|
char *type;
|
|
|
|
/* trigger name */
|
|
char *trigger;
|
|
|
|
/* backend state */
|
|
void *state;
|
|
|
|
/* emit events */
|
|
int (*emit)(void *state, event_t *event);
|
|
|
|
/* free backend state */
|
|
void (*free)(void *state);
|
|
};
|
|
|
|
/* subsystem functions */
|
|
void event_initialise(void);
|
|
void event_shutdown(void);
|
|
|
|
|
|
/* basic functions to work with event registrations */
|
|
event_registration_t * event_new_from_xml_node(xmlNodePtr node);
|
|
|
|
void event_registration_push(event_registration_t **er, event_registration_t *tail);
|
|
|
|
/* event signaling */
|
|
void event_emit_va(const char *trigger, ...);
|
|
#define event_emit_global(event) event_emit_va((event), EVENT_EXTRA_LIST_END)
|
|
|
|
/* reading extra from events */
|
|
const char * event_extra_get(const event_t *event, const event_extra_key_t key);
|
|
const char * event_extra_key_name(event_extra_key_t key);
|
|
igloo_error_t event_to_string_renderer(const event_t *event, string_renderer_t *renderer); /* expects renderer in list mode */
|
|
|
|
/* Implementations */
|
|
int event_get_exec(event_registration_t *er, config_options_t *options);
|
|
int event_get_url(event_registration_t *er, config_options_t *options);
|
|
int event_get_log(event_registration_t *er, config_options_t *options);
|
|
|
|
#endif
|