ePOST API

rice.p2p.scribe
Class ScribePolicy.DefaultScribePolicy

java.lang.Object
  extended by rice.p2p.scribe.ScribePolicy.DefaultScribePolicy
All Implemented Interfaces:
ScribePolicy
Direct Known Subclasses:
ScribePolicy.LimitedScribePolicy, ScribeRegrTest.TestScribePolicy
Enclosing interface:
ScribePolicy

public static class ScribePolicy.DefaultScribePolicy
extends java.lang.Object
implements ScribePolicy

The default policy for Scribe, which always allows new children to join and adds children in the order in which they are provided, implicitly providing a depth-first search.

Version:
$Id: ScribePolicy.java 2551 2005-06-06 19:01:02Z jeffh $
Author:
amislove

Nested Class Summary
 
Nested classes/interfaces inherited from interface rice.p2p.scribe.ScribePolicy
ScribePolicy.DefaultScribePolicy, ScribePolicy.LimitedScribePolicy
 
Field Summary
protected  Environment environment
           
 
Constructor Summary
ScribePolicy.DefaultScribePolicy(Environment env)
           
 
Method Summary
 boolean allowSubscribe(SubscribeMessage message, ScribeClient[] clients, NodeHandle[] children)
          This method always return true;
 void childAdded(Topic topic, NodeHandle child)
          Informs this policy that a child was added to a topic - the topic is free to ignore this upcall if it doesn't care.
 void childRemoved(Topic topic, NodeHandle child)
          Informs this policy that a child was removed from a topic - the topic is free to ignore this upcall if it doesn't care.
 void directAnycast(AnycastMessage message, NodeHandle parent, NodeHandle[] children)
          Simply adds the parent and children in order, which implements a depth-first-search.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

environment

protected Environment environment
Constructor Detail

ScribePolicy.DefaultScribePolicy

public ScribePolicy.DefaultScribePolicy(Environment env)
Method Detail

allowSubscribe

public boolean allowSubscribe(SubscribeMessage message,
                              ScribeClient[] clients,
                              NodeHandle[] children)
This method always return true;

Specified by:
allowSubscribe in interface ScribePolicy
Parameters:
message - The subscribe message in question
children - The list of children who are currently subscribed
clients - The list of clients are are currently subscribed
Returns:
True.

directAnycast

public void directAnycast(AnycastMessage message,
                          NodeHandle parent,
                          NodeHandle[] children)
Simply adds the parent and children in order, which implements a depth-first-search.

Specified by:
directAnycast in interface ScribePolicy
Parameters:
message - The anycast message in question
parent - Our current parent for this message's topic
children - Our current children for this message's topic

childAdded

public void childAdded(Topic topic,
                       NodeHandle child)
Informs this policy that a child was added to a topic - the topic is free to ignore this upcall if it doesn't care.

Specified by:
childAdded in interface ScribePolicy
Parameters:
topic - The topic to unsubscribe from
child - The child that was added

childRemoved

public void childRemoved(Topic topic,
                         NodeHandle child)
Informs this policy that a child was removed from a topic - the topic is free to ignore this upcall if it doesn't care.

Specified by:
childRemoved in interface ScribePolicy
Parameters:
topic - The topic to unsubscribe from
child - The child that was removed

ePOST API

Copyright © 2001-2005 - Rice Pastry.