jadex.bdi.runtime

Interface IEventbase

All Superinterfaces:

IElement

public interface IEventbase
extends IElement

Interface for an event base.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInternalEventListener(String type, IInternalEventListener listener) Add a internal event listener.
void	addMessageEventListener(String type, IMessageEventListener listener) Add a message event listener.
IComponentIdentifier	createComponentIdentifier(String name) Create component identifier.
IComponentIdentifier	createComponentIdentifier(String name, boolean local) Create component identifier.
IComponentIdentifier	createComponentIdentifier(String name, boolean local, String[] addresses) Create component identifier.
IComponentIdentifier	createComponentIdentifier(String name, IComponentIdentifier parent) Create component identifier.
IInternalEvent	createInternalEvent(String type) Create a new intenal event.
IMessageEvent	createMessageEvent(String type) Create a new message event.
IMessageEvent	createReply(IMessageEvent event, String msgeventtype) Create a reply to a message event.
void	deregisterMessageEvent(IMessageEvent mevent) Remove a registered message event.
void	dispatchInternalEvent(IInternalEvent event) Dispatch an event.
void	registerMessageEvent(IMessageEvent mevent) Register a conversation or reply_with to be able to send back answers to the source capability.
void	removeInternalEventListener(String type, IInternalEventListener listener) Remove a internal event listener.
void	removeMessageEventListener(String type, IMessageEventListener listener) Remove a message event listener.
IFuture	sendMessage(IMessageEvent me) Send a message after some delay.

Methods inherited from interface jadex.bdi.runtime.IElement

getModelElement

Method Detail

sendMessage

IFuture sendMessage(IMessageEvent me)

Send a message after some delay.

Parameters:

me - The message event.

Returns:

The filter to wait for an answer.

dispatchInternalEvent

void dispatchInternalEvent(IInternalEvent event)

Dispatch an event.

Parameters:

event - The event.

createMessageEvent

IMessageEvent createMessageEvent(String type)

Create a new message event.

Returns:

The new message event.

createReply

IMessageEvent createReply(IMessageEvent event,
                        String msgeventtype)

Create a reply to a message event.

Parameters:

event - The received message event.

msgeventtype - The reply message event type.

Returns:

The reply event.

createInternalEvent

IInternalEvent createInternalEvent(String type)

Create a new intenal event.

Returns:

The new intenal event.

registerMessageEvent

void registerMessageEvent(IMessageEvent mevent)

Register a conversation or reply_with to be able to send back answers to the source capability.

Parameters:

msgevent - The message event. todo: indexing for msgevents for speed.

deregisterMessageEvent

void deregisterMessageEvent(IMessageEvent mevent)

Remove a registered message event.

Parameters:

msgevent - The message event.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name)

Create component identifier.

Parameters:

name - The name.

local - True for local name.

addresses - The addresses.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             IComponentIdentifier parent)

Create component identifier.

Parameters:

name - The name.

parent - The parent identifier.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             boolean local)

Create component identifier.

Parameters:

name - The name.

local - True for local name.

addresses - The addresses.

Returns:

The new component identifier.

createComponentIdentifier

IComponentIdentifier createComponentIdentifier(String name,
                                             boolean local,
                                             String[] addresses)

Create component identifier.

Parameters:

name - The name.

local - True for local name.

addresses - The addresses.

Returns:

The new component identifier.

addInternalEventListener

void addInternalEventListener(String type,
                            IInternalEventListener listener)

Add a internal event listener.

Parameters:

type - The internal event type.

listener - The internal event listener.

async - True, if the notification should be done on a separate thread.

removeInternalEventListener

void removeInternalEventListener(String type,
                               IInternalEventListener listener)

Remove a internal event listener.

Parameters:

type - The internal event type.

listener - The internal event listener.

addMessageEventListener

void addMessageEventListener(String type,
                           IMessageEventListener listener)

Add a message event listener.

Parameters:

type - The message event type.

listener - The message event listener.

async - True, if the notification should be done on a separate thread.

removeMessageEventListener

void removeMessageEventListener(String type,
                              IMessageEventListener listener)

Remove a message event listener.

Parameters:

type - The message event type.

listener - The message event listener.