Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

IEvent.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file IEvent.d
00004         
00005         Copyright (C) 2004 Kris Bell
00006         
00007         This software is provided 'as-is', without any express or implied
00008         warranty. In no event will the authors be held liable for damages
00009         of any kind arising from the use of this software.
00010         
00011         Permission is hereby granted to anyone to use this software for any 
00012         purpose, including commercial applications, and to alter it and/or 
00013         redistribute it freely, subject to the following restrictions:
00014         
00015         1. The origin of this software must not be misrepresented; you must 
00016            not claim that you wrote the original software. If you use this 
00017            software in a product, an acknowledgment within documentation of 
00018            said product would be appreciated but is not required.
00019 
00020         2. Altered source versions must be plainly marked as such, and must 
00021            not be misrepresented as being the original software.
00022 
00023         3. This notice may not be removed or altered from any distribution
00024            of the source.
00025 
00026 
00027                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00028 
00029 
00030         @version        Initial version, July 2004      
00031         @author         Kris
00032 
00033 
00034 *******************************************************************************/
00035 
00036 module mango.cluster.model.IEvent;
00037 
00038 private import mango.cache.model.IPayload;
00039 
00040 private import mango.cluster.model.IChannel;
00041 
00042 /*******************************************************************************
00043 
00044         An IEvent is passed to each listener as an argument to the
00045         IEventListener callback interface.
00046 
00047 *******************************************************************************/
00048 
00049 interface IEvent
00050 {
00051         /***********************************************************************
00052 
00053                 The supported styles of event/listener
00054 
00055         ***********************************************************************/
00056         
00057         enum Style {Bulletin, Message};
00058 
00059         /***********************************************************************
00060 
00061                 Return the channel used to initiate the listener
00062 
00063         ***********************************************************************/
00064         
00065         IChannel getChannel();
00066 
00067         /***********************************************************************
00068 
00069                 Return the style of the listener.
00070 
00071         ***********************************************************************/
00072         
00073         Style getStyle();
00074 
00075         /***********************************************************************
00076 
00077                 Return the style name of the listener.
00078 
00079         ***********************************************************************/
00080         
00081         char[] getStyleName();
00082 
00083         /***********************************************************************
00084 
00085                 Invoke the listener with the specified payload
00086 
00087         ***********************************************************************/
00088         
00089         void invoke (IPayload payload);
00090 
00091         /***********************************************************************
00092 
00093                 Send a payload back to the producer. This should support all
00094                 the various event styles.                 
00095 
00096         ***********************************************************************/
00097         
00098         void reply (char[] channel, IPayload payload);
00099 }
00100 
00101 
00102 /*******************************************************************************
00103 
00104         Declares the contract for listeners within the cluster package.
00105         When creating a listener, you provide a class that implements
00106         this interface. The notify() method is invoked (on a seperate
00107         thread) whenever a relevant event occurs.
00108 
00109 *******************************************************************************/
00110 
00111 interface IEventListener
00112 {
00113         void notify (IEvent event, IPayload payload);
00114 }
00115 
00116 

Generated on Sun Nov 7 19:06:52 2004 for Mango by doxygen 1.3.6