edu.uci.isr.yancees.server.plugin
Interface ProtocolPluginInterface

All Superinterfaces:
PluginInterface, PluginListenerInterface
All Known Implementing Classes:
AbstractProtocolPlugin

public interface ProtocolPluginInterface
extends PluginInterface

Adds to the ProtocolPlug-in the ability to process messages coming from clients. A protocol plug-in has two phases in its lifecycle. First, it is created than, it starts receiving messages until its termination, when the session is finalized.


Method Summary
 void receiveProtocolMessage(MessageInterface msg, SubscriberInterface si)
          Receive messages from the protocol
 void terminateSession()
          Gracefully terminates the current plugin
 
Methods inherited from interface edu.uci.isr.yancees.server.plugin.PluginInterface
addListener, addRequiredPlugin, dispose, getFullContext, getFullPath, getId, getRequiredPluginsList, getSubtree, getTag, hasChildren, removeListener
 
Methods inherited from interface edu.uci.isr.yancees.server.plugin.PluginListenerInterface
receivePluginNotification, receivePluginNotification
 

Method Detail

terminateSession

public void terminateSession()
Gracefully terminates the current plugin


receiveProtocolMessage

public void receiveProtocolMessage(MessageInterface msg,
                                   SubscriberInterface si)
                            throws ProtocolPluginException
Receive messages from the protocol

Parameters:
msg - is a message according to the protocol that the plug-in implements.
Throws:
ProtocolPluginException