mirror of
https://github.com/signalwire/freeswitch.git
synced 2026-10-30 15:14:17 +00:00
add esl and fs_cli
git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@10890 d0543943-73ff-0310-b7d9-9358b9ac24b2
This commit is contained in:
Anthony Minessale committed
1 parent
405fcce556
commit
0f12bc31cc
9 files changed
+1981
No files matched your search
@@ -0,0 +1,233 @@
|
||||
/*
|
||||
* Copyright (c) 2007, Anthony Minessale II
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* * 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.
|
||||
*
|
||||
* * Neither the name of the original author; nor the names of any contributors
|
||||
* may be used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER
|
||||
* 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 _ESL_H_
|
||||
#define _ESL_H_
|
||||
|
||||
typedef struct esl_event_header esl_event_header_t;
|
||||
typedef struct esl_event esl_event_t;
|
||||
|
||||
|
||||
#define ESL_SEQ_ESC "\033["
|
||||
/* Ansi Control character suffixes */
|
||||
#define ESL_SEQ_HOME_CHAR 'H'
|
||||
#define ESL_SEQ_HOME_CHAR_STR "H"
|
||||
#define ESL_SEQ_CLEARLINE_CHAR '1'
|
||||
#define ESL_SEQ_CLEARLINE_CHAR_STR "1"
|
||||
#define ESL_SEQ_CLEARLINEEND_CHAR "K"
|
||||
#define ESL_SEQ_CLEARSCR_CHAR0 '2'
|
||||
#define ESL_SEQ_CLEARSCR_CHAR1 'J'
|
||||
#define ESL_SEQ_CLEARSCR_CHAR "2J"
|
||||
#define ESL_SEQ_DEFAULT_COLOR ESL_SEQ_ESC ESL_SEQ_END_COLOR /* Reset to Default fg/bg color */
|
||||
#define ESL_SEQ_AND_COLOR ";" /* To add multiple color definitions */
|
||||
#define ESL_SEQ_END_COLOR "m" /* To end color definitions */
|
||||
/* Foreground colors values */
|
||||
#define ESL_SEQ_F_BLACK "30"
|
||||
#define ESL_SEQ_F_RED "31"
|
||||
#define ESL_SEQ_F_GREEN "32"
|
||||
#define ESL_SEQ_F_YELLOW "33"
|
||||
#define ESL_SEQ_F_BLUE "34"
|
||||
#define ESL_SEQ_F_MAGEN "35"
|
||||
#define ESL_SEQ_F_CYAN "36"
|
||||
#define ESL_SEQ_F_WHITE "37"
|
||||
/* Background colors values */
|
||||
#define ESL_SEQ_B_BLACK "40"
|
||||
#define ESL_SEQ_B_RED "41"
|
||||
#define ESL_SEQ_B_GREEN "42"
|
||||
#define ESL_SEQ_B_YELLOW "43"
|
||||
#define ESL_SEQ_B_BLUE "44"
|
||||
#define ESL_SEQ_B_MAGEN "45"
|
||||
#define ESL_SEQ_B_CYAN "46"
|
||||
#define ESL_SEQ_B_WHITE "47"
|
||||
/* Preset escape sequences - Change foreground colors only */
|
||||
#define ESL_SEQ_FBLACK ESL_SEQ_ESC ESL_SEQ_F_BLACK ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FRED ESL_SEQ_ESC ESL_SEQ_F_RED ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FGREEN ESL_SEQ_ESC ESL_SEQ_F_GREEN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FYELLOW ESL_SEQ_ESC ESL_SEQ_F_YELLOW ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FBLUE ESL_SEQ_ESC ESL_SEQ_F_BLUE ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FMAGEN ESL_SEQ_ESC ESL_SEQ_F_MAGEN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FCYAN ESL_SEQ_ESC ESL_SEQ_F_CYAN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_FWHITE ESL_SEQ_ESC ESL_SEQ_F_WHITE ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BBLACK ESL_SEQ_ESC ESL_SEQ_B_BLACK ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BRED ESL_SEQ_ESC ESL_SEQ_B_RED ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BGREEN ESL_SEQ_ESC ESL_SEQ_B_GREEN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BYELLOW ESL_SEQ_ESC ESL_SEQ_B_YELLOW ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BBLUE ESL_SEQ_ESC ESL_SEQ_B_BLUE ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BMAGEN ESL_SEQ_ESC ESL_SEQ_B_MAGEN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BCYAN ESL_SEQ_ESC ESL_SEQ_B_CYAN ESL_SEQ_END_COLOR
|
||||
#define ESL_SEQ_BWHITE ESL_SEQ_ESC ESL_SEQ_B_WHITE ESL_SEQ_END_COLOR
|
||||
/* Preset escape sequences */
|
||||
#define ESL_SEQ_HOME ESL_SEQ_ESC ESL_SEQ_HOME_CHAR_STR
|
||||
#define ESL_SEQ_CLEARLINE ESL_SEQ_ESC ESL_SEQ_CLEARLINE_CHAR_STR
|
||||
#define ESL_SEQ_CLEARLINEEND ESL_SEQ_ESC ESL_SEQ_CLEARLINEEND_CHAR
|
||||
#define ESL_SEQ_CLEARSCR ESL_SEQ_ESC ESL_SEQ_CLEARSCR_CHAR ESL_SEQ_HOME
|
||||
|
||||
#if !defined(_XOPEN_SOURCE) && !defined(__FreeBSD__) && !defined(__NetBSD__)
|
||||
#define _XOPEN_SOURCE 600
|
||||
#endif
|
||||
|
||||
#ifndef HAVE_STRINGS_H
|
||||
#define HAVE_STRINGS_H 1
|
||||
#endif
|
||||
#ifndef HAVE_SYS_SOCKET_H
|
||||
#define HAVE_SYS_SOCKET_H 1
|
||||
#endif
|
||||
|
||||
#ifndef __WINDOWS__
|
||||
#if defined(WIN32) || defined(WIN64) || defined(_MSC_VER) || defined(_WIN32)
|
||||
#define __WINDOWS__
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifdef _MSC_VER
|
||||
#ifndef __inline__
|
||||
#define __inline__ __inline
|
||||
#endif
|
||||
#if (_MSC_VER >= 1400) /* VC8+ */
|
||||
#ifndef _CRT_SECURE_NO_DEPRECATE
|
||||
#define _CRT_SECURE_NO_DEPRECATE
|
||||
#endif
|
||||
#ifndef _CRT_NONSTDC_NO_DEPRECATE
|
||||
#define _CRT_NONSTDC_NO_DEPRECATE
|
||||
#endif
|
||||
#endif
|
||||
#ifndef strcasecmp
|
||||
#define strcasecmp(s1, s2) _stricmp(s1, s2)
|
||||
#endif
|
||||
#ifndef strncasecmp
|
||||
#define strncasecmp(s1, s2, n) _strnicmp(s1, s2, n)
|
||||
#endif
|
||||
#ifndef snprintf
|
||||
#define snprintf _snprintf
|
||||
#endif
|
||||
#ifndef S_IRUSR
|
||||
#define S_IRUSR _S_IREAD
|
||||
#endif
|
||||
#ifndef S_IWUSR
|
||||
#define S_IWUSR _S_IWRITE
|
||||
#endif
|
||||
#undef HAVE_STRINGS_H
|
||||
#undef HAVE_SYS_SOCKET_H
|
||||
#endif
|
||||
|
||||
#include <time.h>
|
||||
#ifndef WIN32
|
||||
#include <sys/time.h>
|
||||
#endif
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#ifdef HAVE_STRINGS_H
|
||||
#include <strings.h>
|
||||
#endif
|
||||
#include <assert.h>
|
||||
|
||||
|
||||
#define esl_assert(_x) assert(_x)
|
||||
#define esl_safe_free(_x) if (_x) free(_x); _x = NULL
|
||||
#define esl_strlen_zero(s) (!s || *(s) == '\0')
|
||||
#define esl_strlen_zero_buf(s) (*(s) == '\0')
|
||||
|
||||
#ifdef WIN32
|
||||
#include <windows.h>
|
||||
typedef HANDLE esl_socket_t;
|
||||
typedef unsigned __int64 uint64_t;
|
||||
typedef unsigned __int32 uint32_t;
|
||||
typedef unsigned __int16 uint16_t;
|
||||
typedef unsigned __int8 uint8_t;
|
||||
typedef __int64 int64_t;
|
||||
typedef __int32 int32_t;
|
||||
typedef __int16 int16_t;
|
||||
typedef __int8 int8_t;
|
||||
typedef intptr_t esl_ssize_t;
|
||||
typedef int esl_filehandle_t;
|
||||
#else
|
||||
#include <stdint.h>
|
||||
#include <sys/types.h>
|
||||
#include <sys/ioctl.h>
|
||||
#include <stdarg.h>
|
||||
#include <sys/socket.h>
|
||||
#include <netinet/in.h>
|
||||
#include <netdb.h>
|
||||
#define ESL_SOCK_INVALID -1
|
||||
typedef int esl_socket_t;
|
||||
typedef ssize_t esl_ssize_t;
|
||||
typedef int esl_filehandle_t;
|
||||
#endif
|
||||
|
||||
typedef int16_t esl_port_t;
|
||||
|
||||
typedef enum {
|
||||
ESL_SUCCESS,
|
||||
ESL_FAIL
|
||||
} esl_status_t;
|
||||
|
||||
|
||||
typedef struct {
|
||||
struct sockaddr_in sockaddr;
|
||||
struct hostent hostent;
|
||||
char hostbuf[256];
|
||||
esl_socket_t sock;
|
||||
char err[256];
|
||||
int errno;
|
||||
char header_buf[4196];
|
||||
char last_reply[1024];
|
||||
esl_event_t *last_event;
|
||||
int debug;
|
||||
int connected;
|
||||
} esl_handle_t;
|
||||
|
||||
typedef enum {
|
||||
ESL_TRUE = 1,
|
||||
ESL_FALSE = 0
|
||||
} esl_bool_t;
|
||||
|
||||
|
||||
#include "esl_event.h"
|
||||
#include "esl_threadmutex.h"
|
||||
|
||||
size_t esl_url_encode(const char *url, char *buf, size_t len);
|
||||
char *esl_url_decode(char *s);
|
||||
|
||||
esl_status_t esl_connect(esl_handle_t *handle, const char *host, esl_port_t port, const char *password);
|
||||
esl_status_t esl_disconnect(esl_handle_t *handle);
|
||||
esl_status_t esl_send(esl_handle_t *handle, const char *cmd);
|
||||
esl_status_t esl_recv(esl_handle_t *handle);
|
||||
esl_status_t esl_send_recv(esl_handle_t *handle, const char *cmd);
|
||||
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,284 @@
|
||||
/*
|
||||
* Copyright (c) 2007, Anthony Minessale II
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* * 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.
|
||||
*
|
||||
* * Neither the name of the original author; nor the names of any contributors
|
||||
* may be used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER
|
||||
* 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 ESL_EVENT_H
|
||||
#define ESL_EVENT_H
|
||||
|
||||
#include <esl.h>
|
||||
|
||||
typedef enum {
|
||||
ESL_STACK_BOTTOM,
|
||||
ESL_STACK_TOP
|
||||
} esl_stack_t;
|
||||
|
||||
typedef enum {
|
||||
ESL_EVENT_CUSTOM,
|
||||
ESL_EVENT_CHANNEL_CREATE,
|
||||
ESL_EVENT_CHANNEL_DESTROY,
|
||||
ESL_EVENT_CHANNEL_STATE,
|
||||
ESL_EVENT_CHANNEL_ANSWER,
|
||||
ESL_EVENT_CHANNEL_HANGUP,
|
||||
ESL_EVENT_CHANNEL_EXECUTE,
|
||||
ESL_EVENT_CHANNEL_EXECUTE_COMPLETE,
|
||||
ESL_EVENT_CHANNEL_BRIDGE,
|
||||
ESL_EVENT_CHANNEL_UNBRIDGE,
|
||||
ESL_EVENT_CHANNEL_PROGRESS,
|
||||
ESL_EVENT_CHANNEL_PROGRESS_MEDIA,
|
||||
ESL_EVENT_CHANNEL_OUTGOING,
|
||||
ESL_EVENT_CHANNEL_PARK,
|
||||
ESL_EVENT_CHANNEL_UNPARK,
|
||||
ESL_EVENT_CHANNEL_APPLICATION,
|
||||
ESL_EVENT_CHANNEL_ORIGINATE,
|
||||
ESL_EVENT_CHANNEL_UUID,
|
||||
ESL_EVENT_API,
|
||||
ESL_EVENT_LOG,
|
||||
ESL_EVENT_INBOUND_CHAN,
|
||||
ESL_EVENT_OUTBOUND_CHAN,
|
||||
ESL_EVENT_STARTUP,
|
||||
ESL_EVENT_SHUTDOWN,
|
||||
ESL_EVENT_PUBLISH,
|
||||
ESL_EVENT_UNPUBLISH,
|
||||
ESL_EVENT_TALK,
|
||||
ESL_EVENT_NOTALK,
|
||||
ESL_EVENT_SESSION_CRASH,
|
||||
ESL_EVENT_MODULE_LOAD,
|
||||
ESL_EVENT_MODULE_UNLOAD,
|
||||
ESL_EVENT_DTMF,
|
||||
ESL_EVENT_MESSAGE,
|
||||
ESL_EVENT_PRESENCE_IN,
|
||||
ESL_EVENT_NOTIFY_IN,
|
||||
ESL_EVENT_PRESENCE_OUT,
|
||||
ESL_EVENT_PRESENCE_PROBE,
|
||||
ESL_EVENT_MESSAGE_WAITING,
|
||||
ESL_EVENT_MESSAGE_QUERY,
|
||||
ESL_EVENT_ROSTER,
|
||||
ESL_EVENT_CODEC,
|
||||
ESL_EVENT_BACKGROUND_JOB,
|
||||
ESL_EVENT_DETECTED_SPEECH,
|
||||
ESL_EVENT_DETECTED_TONE,
|
||||
ESL_EVENT_PRIVATE_COMMAND,
|
||||
ESL_EVENT_HEARTBEAT,
|
||||
ESL_EVENT_TRAP,
|
||||
ESL_EVENT_ADD_SCHEDULE,
|
||||
ESL_EVENT_DEL_SCHEDULE,
|
||||
ESL_EVENT_EXE_SCHEDULE,
|
||||
ESL_EVENT_RE_SCHEDULE,
|
||||
ESL_EVENT_RELOADXML,
|
||||
ESL_EVENT_NOTIFY,
|
||||
ESL_EVENT_SEND_MESSAGE,
|
||||
ESL_EVENT_RECV_MESSAGE,
|
||||
ESL_EVENT_REQUEST_PARAMS,
|
||||
ESL_EVENT_CHANNEL_DATA,
|
||||
ESL_EVENT_GENERAL,
|
||||
ESL_EVENT_COMMAND,
|
||||
ESL_EVENT_SESSION_HEARTBEAT,
|
||||
ESL_EVENT_ALL
|
||||
} esl_event_types_t;
|
||||
|
||||
typedef enum {
|
||||
ESL_PRIORITY_NORMAL,
|
||||
ESL_PRIORITY_LOW,
|
||||
ESL_PRIORITY_HIGH
|
||||
} esl_priority_t;
|
||||
|
||||
/*! \brief An event Header */
|
||||
struct esl_event_header {
|
||||
/*! the header name */
|
||||
char *name;
|
||||
/*! the header value */
|
||||
char *value;
|
||||
/*! hash of the header name */
|
||||
unsigned long hash;
|
||||
struct esl_event_header *next;
|
||||
};
|
||||
|
||||
|
||||
/*! \brief Representation of an event */
|
||||
struct esl_event {
|
||||
/*! the event id (descriptor) */
|
||||
esl_event_types_t event_id;
|
||||
/*! the priority of the event */
|
||||
esl_priority_t priority;
|
||||
/*! the owner of the event */
|
||||
char *owner;
|
||||
/*! the subclass of the event */
|
||||
char *subclass_name;
|
||||
/*! the event headers */
|
||||
esl_event_header_t *headers;
|
||||
/*! the event headers tail pointer */
|
||||
esl_event_header_t *last_header;
|
||||
/*! the body of the event */
|
||||
char *body;
|
||||
/*! user data from the subclass provider */
|
||||
void *bind_user_data;
|
||||
/*! user data from the event sender */
|
||||
void *event_user_data;
|
||||
/*! unique key */
|
||||
unsigned long key;
|
||||
struct esl_event *next;
|
||||
};
|
||||
|
||||
|
||||
|
||||
#define ESL_EVENT_SUBCLASS_ANY NULL
|
||||
|
||||
/*!
|
||||
\brief Create an event
|
||||
\param event a NULL pointer on which to create the event
|
||||
\param event_id the event id enumeration of the desired event
|
||||
\param subclass_name the subclass name for custom event (only valid when event_id is ESL_EVENT_CUSTOM)
|
||||
\return ESL_STATUS_SUCCESS on success
|
||||
*/
|
||||
esl_status_t esl_event_create_subclass(esl_event_t **event, esl_event_types_t event_id, const char *subclass_name);
|
||||
|
||||
/*!
|
||||
\brief Set the priority of an event
|
||||
\param event the event to set the priority on
|
||||
\param priority the event priority
|
||||
\return ESL_STATUS_SUCCESS
|
||||
*/
|
||||
esl_status_t esl_event_set_priority(esl_event_t *event, esl_priority_t priority);
|
||||
|
||||
/*!
|
||||
\brief Retrieve a header value from an event
|
||||
\param event the event to read the header from
|
||||
\param header_name the name of the header to read
|
||||
\return the value of the requested header
|
||||
*/
|
||||
char *esl_event_get_header(esl_event_t *event, const char *header_name);
|
||||
|
||||
/*!
|
||||
\brief Retrieve the body value from an event
|
||||
\param event the event to read the body from
|
||||
\return the value of the body or NULL
|
||||
*/
|
||||
char *esl_event_get_body(esl_event_t *event);
|
||||
|
||||
/*!
|
||||
\brief Add a header to an event
|
||||
\param event the event to add the header to
|
||||
\param stack the stack sense (stack it on the top or on the bottom)
|
||||
\param header_name the name of the header to add
|
||||
\param fmt the value of the header (varargs see standard sprintf family)
|
||||
\return ESL_STATUS_SUCCESS if the header was added
|
||||
*/
|
||||
esl_status_t esl_event_add_header(esl_event_t *event, esl_stack_t stack,
|
||||
const char *header_name, const char *fmt, ...); //PRINTF_FUNCTION(4, 5);
|
||||
|
||||
/*!
|
||||
\brief Add a string header to an event
|
||||
\param event the event to add the header to
|
||||
\param stack the stack sense (stack it on the top or on the bottom)
|
||||
\param header_name the name of the header to add
|
||||
\param data the value of the header
|
||||
\return ESL_STATUS_SUCCESS if the header was added
|
||||
*/
|
||||
esl_status_t esl_event_add_header_string(esl_event_t *event, esl_stack_t stack, const char *header_name, const char *data);
|
||||
|
||||
esl_status_t esl_event_del_header(esl_event_t *event, const char *header_name);
|
||||
|
||||
/*!
|
||||
\brief Destroy an event
|
||||
\param event pointer to the pointer to event to destroy
|
||||
*/
|
||||
void esl_event_destroy(esl_event_t **event);
|
||||
#define esl_event_safe_destroy(_event) if (_event) esl_event_destroy(_event)
|
||||
|
||||
/*!
|
||||
\brief Duplicate an event
|
||||
\param event a NULL pointer on which to duplicate the event
|
||||
\param todup an event to duplicate
|
||||
\return ESL_STATUS_SUCCESS if the event was duplicated
|
||||
*/
|
||||
esl_status_t esl_event_dup(esl_event_t **event, esl_event_t *todup);
|
||||
|
||||
/*!
|
||||
\brief Render the name of an event id enumeration
|
||||
\param event the event id to render the name of
|
||||
\return the rendered name
|
||||
*/
|
||||
const char *esl_event_name(esl_event_types_t event);
|
||||
|
||||
/*!
|
||||
\brief return the event id that matches a given event name
|
||||
\param name the name of the event
|
||||
\param type the event id to return
|
||||
\return ESL_STATUS_SUCCESS if there was a match
|
||||
*/
|
||||
esl_status_t esl_name_event(const char *name, esl_event_types_t *type);
|
||||
|
||||
/*!
|
||||
\brief Render a string representation of an event sutable for printing or network transport
|
||||
\param event the event to render
|
||||
\param str a string pointer to point at the allocated data
|
||||
\param encode url encode the headers
|
||||
\return ESL_STATUS_SUCCESS if the operation was successful
|
||||
\note you must free the resulting string when you are finished with it
|
||||
*/
|
||||
esl_status_t esl_event_serialize(esl_event_t *event, char **str, esl_bool_t encode);
|
||||
|
||||
/*!
|
||||
\brief Add a body to an event
|
||||
\param event the event to add to body to
|
||||
\param fmt optional body of the event (varargs see standard sprintf family)
|
||||
\return ESL_STATUS_SUCCESS if the body was added to the event
|
||||
\note the body parameter can be shadowed by the esl_event_reserve_subclass_detailed function
|
||||
*/
|
||||
esl_status_t esl_event_add_body(esl_event_t *event, const char *fmt, ...);
|
||||
|
||||
/*!
|
||||
\brief Create a new event assuming it will not be custom event and therefore hiding the unused parameters
|
||||
\param event a NULL pointer on which to create the event
|
||||
\param id the event id enumeration of the desired event
|
||||
\return ESL_STATUS_SUCCESS on success
|
||||
*/
|
||||
#define esl_event_create(event, id) esl_event_create_subclass(event, id, ESL_EVENT_SUBCLASS_ANY)
|
||||
|
||||
const char *esl_priority_name(esl_priority_t priority);
|
||||
|
||||
///\}
|
||||
|
||||
|
||||
#endif
|
||||
|
||||
/* For Emacs:
|
||||
* Local Variables:
|
||||
* mode:c
|
||||
* indent-tabs-mode:t
|
||||
* tab-width:4
|
||||
* c-basic-offset:4
|
||||
* End:
|
||||
* For VIM:
|
||||
* vim:set softtabstop=4 shiftwidth=4 tabstop=4:
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Cross Platform Thread/Mutex abstraction
|
||||
* Copyright(C) 2007 Michael Jerris
|
||||
*
|
||||
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||||
* copies of the Software, and permit persons to whom the Software is
|
||||
* furnished to do so.
|
||||
*
|
||||
* This work is provided under this license on an "as is" basis, without warranty of any kind,
|
||||
* either expressed or implied, including, without limitation, warranties that the covered code
|
||||
* is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire
|
||||
* risk as to the quality and performance of the covered code is with you. Should any covered
|
||||
* code prove defective in any respect, you (not the initial developer or any other contributor)
|
||||
* assume the cost of any necessary servicing, repair or correction. This disclaimer of warranty
|
||||
* constitutes an essential part of this license. No use of any covered code is authorized hereunder
|
||||
* except under this disclaimer.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
#ifndef _ESL_THREADMUTEX_H
|
||||
#define _ESL_THREADMUTEX_H
|
||||
|
||||
#include "esl.h"
|
||||
|
||||
typedef struct esl_mutex esl_mutex_t;
|
||||
typedef struct esl_thread esl_thread_t;
|
||||
typedef void *(*esl_thread_function_t) (esl_thread_t *, void *);
|
||||
|
||||
esl_status_t esl_thread_create_detached(esl_thread_function_t func, void *data);
|
||||
esl_status_t esl_thread_create_detached_ex(esl_thread_function_t func, void *data, size_t stack_size);
|
||||
void esl_thread_override_default_stacksize(size_t size);
|
||||
esl_status_t esl_mutex_create(esl_mutex_t **mutex);
|
||||
esl_status_t esl_mutex_destroy(esl_mutex_t **mutex);
|
||||
esl_status_t esl_mutex_lock(esl_mutex_t *mutex);
|
||||
esl_status_t esl_mutex_trylock(esl_mutex_t *mutex);
|
||||
esl_status_t esl_mutex_unlock(esl_mutex_t *mutex);
|
||||
|
||||
#endif
|
||||
|
||||
/* For Emacs:
|
||||
* Local Variables:
|
||||
* mode:c
|
||||
* indent-tabs-mode:t
|
||||
* tab-width:4
|
||||
* c-basic-offset:4
|
||||
* End:
|
||||
* For VIM:
|
||||
* vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user