diff options
Diffstat (limited to 'Source/DirectFB/lib/fusion/reactor.h')
| -rwxr-xr-x | Source/DirectFB/lib/fusion/reactor.h | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/Source/DirectFB/lib/fusion/reactor.h b/Source/DirectFB/lib/fusion/reactor.h new file mode 100755 index 0000000..3466c5a --- /dev/null +++ b/Source/DirectFB/lib/fusion/reactor.h @@ -0,0 +1,197 @@ +/* + (c) Copyright 2001-2009 The world wide DirectFB Open Source Community (directfb.org) + (c) Copyright 2000-2004 Convergence (integrated media) GmbH + + All rights reserved. + + Written by Denis Oliver Kropp <dok@directfb.org>, + Andreas Hundt <andi@fischlustig.de>, + Sven Neumann <neo@directfb.org>, + Ville Syrjälä <syrjala@sci.fi> and + Claudio Ciccani <klan@users.sf.net>. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. +*/ + +#ifndef __FUSION__REACTOR_H__ +#define __FUSION__REACTOR_H__ + +#include <direct/list.h> + +#include <fusion/types.h> +#include <fusion/call.h> +#include <fusion/lock.h> + +typedef enum { + RS_OK, + RS_REMOVE, + RS_DROP +} ReactionResult; + +typedef ReactionResult (*ReactionFunc)( const void *msg_data, + void *ctx ); + +typedef struct { + DirectLink link; + ReactionFunc func; + void *ctx; + void *node_link; +} Reaction; + +typedef struct { + DirectLink link; + int index; + void *ctx; + bool attached; +} GlobalReaction; + + +/* + * Create a new reactor configured for the specified message data size. + */ +FusionReactor *fusion_reactor_new ( int msg_size, + const char *name, + const FusionWorld *world ); + +/* + * Destroy the reactor. + */ +DirectResult fusion_reactor_destroy ( FusionReactor *reactor ); + +/* + * Free the reactor. + */ +DirectResult fusion_reactor_free ( FusionReactor *reactor ); + + +/* + * Makes the reactor use the specified lock for managing global reactions. + * + * After creating the reactor a global default lock is set which is created + * by Fusion once during initialization. + * + * To avoid dead locks caused by alternating lock orders of the global reaction + * lock and another lock, the default lock is replaced by the other lock. + */ +DirectResult fusion_reactor_set_lock ( FusionReactor *reactor, + FusionSkirmish *skirmish ); + +DirectResult fusion_reactor_set_lock_only( FusionReactor *reactor, + FusionSkirmish *lock ); + +/* + * Attach a local reaction to the reactor (channel 0). + */ +DirectResult fusion_reactor_attach ( FusionReactor *reactor, + ReactionFunc func, + void *ctx, + Reaction *reaction ); + +/* + * Attach a local reaction to a specific reactor channel (0-1023). + */ +DirectResult fusion_reactor_attach_channel( FusionReactor *reactor, + int channel, + ReactionFunc func, + void *ctx, + Reaction *reaction ); + +/* + * Detach an attached local reaction from the reactor. + */ +DirectResult fusion_reactor_detach ( FusionReactor *reactor, + Reaction *reaction ); + + +/* + * Attach a global reaction to the reactor. + * + * It's always called directly, no matter which Fusionee calls fusion_reactor_dispatch(). + * Any data referenced by the reaction function has to be in shared memory, unless it uses a + * mechanism to lookup a local counter part or representative, based on shared information. + * + * A global reaction is not defined directly as a function pointer, because that's always a + * local address. Instead, it's specified by an index into a built in function table that + * must be passed to fusion_reactor_dispatch() each time it is called. + */ +DirectResult fusion_reactor_attach_global( FusionReactor *reactor, + int index, + void *ctx, + GlobalReaction *reaction ); + +/* + * Detach an attached global reaction from the reactor. + */ +DirectResult fusion_reactor_detach_global( FusionReactor *reactor, + GlobalReaction *reaction ); + +/* + * Dispatch a message to any attached reaction (channel 0). + * + * Setting 'self' to false excludes the caller's local reactions. + */ +DirectResult fusion_reactor_dispatch ( FusionReactor *reactor, + const void *msg_data, + bool self, + const ReactionFunc *globals ); + +/* + * Dispatch a message to any attached reaction with a given size. Instead of + * using the size defined by the reactor, the caller can specify the size of + * the data. + * + * Setting 'self' to false excludes the caller's local reactions. + */ +DirectResult fusion_reactor_sized_dispatch( FusionReactor *reactor, + const void *msg_data, + int msg_size, + bool self, + const ReactionFunc *globals ); + +/* + * Dispatch a message via a specific channel (0-1023). + * + * Setting 'self' to false excludes the caller's local reactions. + */ +DirectResult fusion_reactor_dispatch_channel( FusionReactor *reactor, + int channel, + const void *msg_data, + int msg_size, + bool self, + const ReactionFunc *globals ); + + +/* + * Have the call executed when a dispatched message has been processed by all recipients. + */ +DirectResult fusion_reactor_set_dispatch_callback( FusionReactor *reactor, + FusionCall *call, + void *call_ptr ); + +/* + * Change the name of the reactor (debug). + */ +DirectResult fusion_reactor_set_name ( FusionReactor *reactor, + const char *name ); + +/* + * Specify whether local message handlers (reactions) should be called directly. + */ +DirectResult fusion_reactor_direct ( FusionReactor *reactor, + bool direct ); + +#endif + |