freeswitch/src/include/switch_event.h
Anthony Minessale ab0b99eb00 more event stuff
you should now be able to bind an event handler to a 
paticiular file or function not just a paticular event
when using the custom event 

like "file:somefile.c"
or "func:somefunc"

also events now have headers which can be added 
with varargs and should be created and delivered with api calls


switch_event *event;

regular event:
if (switch_event_create(&event, SWITCH_EVENT_STARTUP) == SWITCH_STATUS_SUCCESS) {
	switch_event_add_header(event, "event_info", "System Ready");
	switch_event_fire(&event);
}

custom event:
if (switch_event_create_subclass(&event, SWITCH_EVENT_CUSTOM, "some_subclass_string") == SWITCH_STATUS_SUCCESS) {
	switch_event_add_header(event, "event_info", "hello world %d", 42);
	switch_event_fire(&event);
} 

switch_event_add_header(event, "test %d", 42);

also you can serialize and event into a buffer in
a printable/transferrable format with optional body

char buf[1024];

with body:
switch_event_serialize(event, buf, sizeof(buf), "This is a body my favorite number is %d", 42);

no body:
switch_event_serialize(event, buf, sizeof(buf), NULL);






git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@173 d0543943-73ff-0310-b7d9-9358b9ac24b2
2005-12-19 19:57:32 +00:00

90 lines
3.2 KiB
C

/*
* FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
* Copyright (C) 2005/2006, Anthony Minessale II <anthmct@yahoo.com>
*
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
*
* The Initial Developer of the Original Code is
* Anthony Minessale II <anthmct@yahoo.com>
* Portions created by the Initial Developer are Copyright (C)
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Anthony Minessale II <anthmct@yahoo.com>
*
*
* switch_event.h -- Event System
*
*/
#ifndef SWITCH_EVENT_H
#define SWITCH_EVENT_H
#ifdef __cplusplus
extern "C" {
#endif
#include <switch.h>
struct switch_event_header {
char *name;
char *value;
struct switch_event_header *next;
};
struct switch_event_subclass {
char *owner;
char *name;
};
struct switch_event {
switch_event_t event_id;
char *owner;
switch_event_subclass *subclass;
struct switch_event_header *headers;
void *user_data;
struct switch_event *next;
};
struct switch_event_node {
char *id;
switch_event_t event_id;
switch_event_subclass *subclass;
switch_event_callback_t callback;
void *user_data;
struct switch_event_node *next;
};
#define SWITCH_EVENT_SUBCLASS_ANY NULL
SWITCH_DECLARE(switch_status) switch_event_shutdown(void);
SWITCH_DECLARE(switch_status) switch_event_init(switch_memory_pool *pool);
SWITCH_DECLARE(switch_status) switch_event_create_subclass(switch_event **event, switch_event_t event_id, char *subclass_name);
SWITCH_DECLARE(char *) switch_event_get_header(switch_event *event, char *header_name);
SWITCH_DECLARE(switch_status) switch_event_add_header(switch_event *event, char *header_name, char *fmt, ...);
SWITCH_DECLARE(void) switch_event_destroy(switch_event **event);
SWITCH_DECLARE(switch_status) switch_event_dup(switch_event **event, switch_event *todup);
SWITCH_DECLARE(switch_status) switch_event_fire_detailed(char *file, char *func, int line, switch_event **event);
SWITCH_DECLARE(switch_status) switch_event_bind(char *id, switch_event_t event, char *subclass_name, switch_event_callback_t callback, void *user_data);
SWITCH_DECLARE(char *) switch_event_name(switch_event_t event);
SWITCH_DECLARE(switch_status) switch_event_reserve_subclass_detailed(char *owner, char *subclass_name);
SWITCH_DECLARE(switch_status) switch_event_serialize(switch_event *event, char *buf, size_t buflen, char *fmt, ...);
#define switch_event_reserve_subclass(subclass_name) switch_event_reserve_subclass_detailed(__FILE__, subclass_name)
#define switch_event_create(event, id) switch_event_create_subclass(event, id, SWITCH_EVENT_SUBCLASS_ANY)
#define switch_event_fire(event) switch_event_fire_detailed(__FILE__, __FUNCTION__, __LINE__, event)
#endif