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 4. Derivative works are permitted, but they must carry this notice 00027 in full and credit the original source. 00028 00029 00030 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 00031 00032 00033 @version Initial version, July 2004 00034 @author Kris 00035 00036 00037 *******************************************************************************/ 00038 00039 module mango.cluster.model.IEvent; 00040 00041 private import mango.cache.model.IPayload; 00042 00043 private import mango.cluster.model.IChannel; 00044 00045 /******************************************************************************* 00046 00047 An IEvent is passed to each listener as an argument to the 00048 IEventListener callback interface. 00049 00050 *******************************************************************************/ 00051 00052 interface IEvent 00053 { 00054 /*********************************************************************** 00055 00056 The supported styles of event/listener 00057 00058 ***********************************************************************/ 00059 00060 enum Style {Bulletin, Message}; 00061 00062 /*********************************************************************** 00063 00064 Return the channel used to initiate the listener 00065 00066 ***********************************************************************/ 00067 00068 IChannel getChannel(); 00069 00070 /*********************************************************************** 00071 00072 Return the style of the listener. 00073 00074 ***********************************************************************/ 00075 00076 Style getStyle(); 00077 00078 /*********************************************************************** 00079 00080 Return the style name of the listener. 00081 00082 ***********************************************************************/ 00083 00084 char[] getStyleName(); 00085 00086 /*********************************************************************** 00087 00088 Invoke the listener with the specified payload 00089 00090 ***********************************************************************/ 00091 00092 void invoke (IPayload payload); 00093 00094 /*********************************************************************** 00095 00096 Send a payload back to the producer. This should support all 00097 the various event styles. 00098 00099 ***********************************************************************/ 00100 00101 void reply (char[] channel, IPayload payload); 00102 } 00103 00104 00105 /******************************************************************************* 00106 00107 Declares the contract for listeners within the cluster package. 00108 When creating a listener, you provide a class that implements 00109 this interface. The notify() method is invoked (on a seperate 00110 thread) whenever a relevant event occurs. 00111 00112 *******************************************************************************/ 00113 00114 interface IEventListener 00115 { 00116 void notify (IEvent event, IPayload payload); 00117 } 00118 00119