-/*
- * mlt_events.h -- event handling
- * Copyright (C) 2004-2005 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_events.c
+ * \brief event handling
+ * \see mlt_events_struct
+ *
+ * Copyright (C) 2004-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
#include "mlt_properties.h"
#include "mlt_events.h"
-/** Memory leak checks.
-*/
+/* Memory leak checks. */
-//#define _MLT_EVENT_CHECKS_
+#undef _MLT_EVENT_CHECKS_
#ifdef _MLT_EVENT_CHECKS_
static int events_created = 0;
static int events_destroyed = 0;
#endif
+/** \brief Events class
+ *
+ * Events provide messages and notifications between services and the application.
+ * A service can register an event and fire/send it upon certain conditions or times.
+ * Likewise, a service or an application can listen/receive specific events on specific
+ * services.
+ */
+
struct mlt_events_struct
{
mlt_properties owner;
typedef struct mlt_events_struct *mlt_events;
+/** \brief Event class
+ *
+ */
+
struct mlt_event_struct
{
mlt_events owner;
};
/** Increment the reference count on this event.
-*/
+ *
+ * \public \memberof mlt_event_struct
+ * \param this an event
+ */
void mlt_event_inc_ref( mlt_event this )
{
}
/** Increment the block count on this event.
-*/
+ *
+ * \public \memberof mlt_event_struct
+ * \param this an event
+ */
void mlt_event_block( mlt_event this )
{
}
/** Decrement the block count on this event.
-*/
+ *
+ * \public \memberof mlt_event_struct
+ * \param this an event
+ */
void mlt_event_unblock( mlt_event this )
{
}
/** Close this event.
-*/
+ *
+ * \public \memberof mlt_event_struct
+ * \param this an event
+ */
void mlt_event_close( mlt_event this )
{
if ( this->ref_count <= 0 )
{
#ifdef _MLT_EVENT_CHECKS_
- events_destroyed ++;
- fprintf( stderr, "Events created %d, destroyed %d\n", events_created, events_destroyed );
+ mlt_log( NULL, MLT_LOG_DEBUG, "Events created %d, destroyed %d\n", events_created, ++events_destroyed );
#endif
free( this );
}
}
}
-/** Forward declaration to private functions.
+/* Forward declaration to private functions.
*/
static mlt_events mlt_events_fetch( mlt_properties );
static void mlt_events_close( mlt_events );
/** Initialise the events structure.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ */
void mlt_events_init( mlt_properties this )
{
}
/** Register an event and transmitter.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param id the name of an event
+ * \param transmitter the callback function to send an event message
+ * \return true if there was an error
+ */
-int mlt_events_register( mlt_properties this, char *id, mlt_transmitter transmitter )
+int mlt_events_register( mlt_properties this, const char *id, mlt_transmitter transmitter )
{
int error = 1;
mlt_events events = mlt_events_fetch( this );
}
/** Fire an event.
-*/
+ *
+ * This takes a variable number of arguments to supply to the listener.
+
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param id the name of an event
+ */
-void mlt_events_fire( mlt_properties this, char *id, ... )
+void mlt_events_fire( mlt_properties this, const char *id, ... )
{
mlt_events events = mlt_events_fetch( this );
if ( events != NULL )
}
/** Register a listener.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param service an opaque pointer
+ * \param id the name of the event to listen for
+ * \param listener the callback to receive an event message
+ * \return
+ */
-mlt_event mlt_events_listen( mlt_properties this, void *service, char *id, mlt_listener listener )
+mlt_event mlt_events_listen( mlt_properties this, void *service, const char *id, mlt_listener listener )
{
mlt_event event = NULL;
mlt_events events = mlt_events_fetch( this );
}
/** Block all events for a given service.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param service an opaque pointer
+ */
void mlt_events_block( mlt_properties this, void *service )
{
}
/** Unblock all events for a given service.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param service an opaque pointer
+ */
void mlt_events_unblock( mlt_properties this, void *service )
{
}
/** Disconnect all events for a given service.
-*/
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param service an opaque pointer
+ */
void mlt_events_disconnect( mlt_properties this, void *service )
{
}
}
+/** \brief private to mlt_events_struct, used by mlt_events_wait_for() */
+
typedef struct
{
int done;
}
condition_pair;
+/** The event listener callback for the wait functions.
+ *
+ * \private \memberof mlt_events_struct
+ * \param this a properties list
+ * \param pair a condition pair
+ */
+
static void mlt_events_listen_for( mlt_properties this, condition_pair *pair )
{
pthread_mutex_lock( &pair->mutex );
}
}
-mlt_event mlt_events_setup_wait_for( mlt_properties this, char *id )
+/** Prepare to wait for an event.
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param id the name of the event to wait for
+ * \return an event
+ */
+
+mlt_event mlt_events_setup_wait_for( mlt_properties this, const char *id )
{
condition_pair *pair = malloc( sizeof( condition_pair ) );
pair->done = 0;
return mlt_events_listen( this, pair, id, ( mlt_listener )mlt_events_listen_for );
}
+/** Wait for an event.
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param event an event
+ */
+
void mlt_events_wait_for( mlt_properties this, mlt_event event )
{
if ( event != NULL )
}
}
+/** Cleanup after waiting for an event.
+ *
+ * \public \memberof mlt_events_struct
+ * \param this a properties list
+ * \param event an event
+ */
+
void mlt_events_close_wait_for( mlt_properties this, mlt_event event )
{
if ( event != NULL )
}
/** Fetch the events object.
-*/
+ *
+ * \private \memberof mlt_events_struct
+ * \param this a properties list
+ * \return an events object
+ */
static mlt_events mlt_events_fetch( mlt_properties this )
{
}
/** Store the events object.
-*/
+ *
+ * \private \memberof mlt_events_struct
+ * \param this a properties list
+ * \param events an events object
+ */
static void mlt_events_store( mlt_properties this, mlt_events events )
{
}
/** Close the events object.
-*/
+ *
+ * \private \memberof mlt_events_struct
+ * \param events an events object
+ */
static void mlt_events_close( mlt_events events )
{
free( events );
}
}
-
projects / melted / blobdiff