org.da.protoframework.eventlogger

Interface EventEngine

public interface EventEngine

The interface for event engines.

Method Summary

Modifier and Type	Method and Description
void	end() Called at the end of the recording.
void	init(Framework framework, java.net.URL eventsURL) Initialize the engine.
void	invoke(NamespaceKey service, int id, ModuleKey fromModule) Called when one invocation event must be recorded.
boolean	isActive() Return true if the engine is active.
void	notified(NamespaceKey service, int id, ModuleKey fromModule, ModuleKey toModule) Called when one notification event must be recorded.
default void	receivedFromNetwork(NamespaceKey service) Called when one invocation event from the network must be recorded.
default void	sendToNetwork(NamespaceKey service) Called when one invocation event to the network must be recorded.
void	setStartTimeStamp(long startTimeStamp) Called when the engine must be started.
void	start() Called when the engine must be started.
void	stop() Called when the engine must be stopped.

Method Detail

init

void init(Framework framework,
          java.net.URL eventsURL)

Initialize the engine.

Parameters:

framework - the framework

eventsURL - the events URL to generate

setStartTimeStamp

void setStartTimeStamp(long startTimeStamp)

Called when the engine must be started.

Parameters:

startTimeStamp - the starting time stamp

start

void start()

Called when the engine must be started.

isActive

boolean isActive()

Return true if the engine is active.

Returns:

true if the engine is active

invoke

void invoke(NamespaceKey service,
            int id,
            ModuleKey fromModule)

Called when one invocation event must be recorded.

Parameters:

service - the service key

id - the event id

fromModule - the key of the module which invokes the event

sendToNetwork

default void sendToNetwork(NamespaceKey service)

Called when one invocation event to the network must be recorded. Do nothing by default.

Parameters:

service - the service key

notified

void notified(NamespaceKey service,
              int id,
              ModuleKey fromModule,
              ModuleKey toModule)

Called when one notification event must be recorded.

Parameters:

service - the service key

id - the event id

fromModule - the key of the module which invokes the event

toModule - the key of the module which is notified from the event

receivedFromNetwork

default void receivedFromNetwork(NamespaceKey service)

Called when one invocation event from the network must be recorded. Do nothing by default.

Parameters:

service - the service key

stop

void stop()

Called when the engine must be stopped.

end

void end()

Called at the end of the recording.