rice.p2p.scribe
Class ScribeImpl

java.lang.Object
  rice.p2p.scribe.ScribeImpl

All Implemented Interfaces:

Destructable, Application, Scribe

public class ScribeImpl
extends java.lang.Object
implements Scribe, Application

Version:

$Id: ScribeImpl.java 3650 2007-03-18 19:33:01Z jeffh $

Author:

Alan Mislove

Nested Class Summary

class

ScribeImpl.TopicManager Class which keeps track of a given topic

Field Summary

java.util.HashMap<NodeHandle,java.util.List<Topic>>	allChildren This contains a mapping of child - > all topics for which the local node has this node(hashtable key) as a child
java.util.HashMap<NodeHandle,java.util.List<Topic>>	allParents This contains a mapping of parent - > all topics for which the local node has this node(hashtable key) as a parent
protected Endpoint	endpoint this application's endpoint
protected NodeHandle	handle the local node handle
static int	INFO_2
int	MAINTENANCE_INTERVAL The interval with which to perform maintenance
int	MESSAGE_TIMEOUT the timeout for a subscribe message
protected ScribePolicy	policy this scribe's policy
java.util.Hashtable<Topic,ScribeImpl.TopicManager>	topics the hashtable of topic -> TopicManager

Constructor Summary

ScribeImpl(Node node, ScribePolicy policy, java.lang.String instance)
Constructor for Scribe

ScribeImpl(Node node, java.lang.String instance)
Constructor for Scribe, using the default policy.

Method Summary

protected void	ackMessageReceived(SubscribeAckMessage message) Internal method which processes an ack message
void	addChild(Topic topic, NodeHandle child) Adds a child to the given topic
protected void	addChild(Topic topic, NodeHandle child, int id) Adds a child to the given topic, using the specified sequence number in the ack message sent to the child.
boolean	allChildrenContains(Topic t, NodeHandle child)
boolean	allChildrenContainsChild(NodeHandle child)
boolean	allParentsContains(Topic t, NodeHandle parent)
boolean	allParentsContainsParent(NodeHandle parent)
void	anycast(Topic topic, RawScribeContent content)
void	anycast(Topic topic, RawScribeContent content, NodeHandle hint)
void	anycast(Topic topic, ScribeContent content) Anycasts the given content to a member of the given topic
void	anycast(Topic topic, ScribeContent content, NodeHandle hint) Anycasts the given content to a member of the given topic The hint helps us to implement centralized algorithms where the hint is the cachedRoot for the topic.
boolean	containsChild(Topic topic, NodeHandle child)
boolean	containsTopic(Topic topic) Returns true if there is a TopicManager associated with this topic (any parent/children/client exists)
void	deliver(Id id, Message message) This method is called on the application at the destination node for the given id.
void	destroy()
boolean	forward(RouteMessage message) This method is invoked on applications when the underlying node is about to forward the given message with the provided target to the specified next hop.
NodeHandle[]	getChildren(Topic topic) Returns the list of children for a given topic
ScribeClient[]	getClients(Topic topic) Returns the list of clients for a given topic
ScribeContentDeserializer	getContentDeserializer()
Environment	getEnvironment()
Id	getId() Returns the Id of the local node
NodeHandle	getParent(Topic topic) Returns the parent for a given topic
ScribePolicy	getPolicy() Returns the current policy for this scribe object
NodeHandle	getRoot(Topic topic)
Topic[]	getTopics(ScribeClient client) Returns the list of topics the given client is subscribed to.
boolean	isRoot(Topic topic) Returns whether or not this Scribe is the root for the given topic
int	numChildren(Topic topic)
void	printAllChildrenDataStructure()
void	printAllParentsDataStructure()
void	publish(Topic topic, RawScribeContent content)
void	publish(Topic topic, ScribeContent content) Publishes the given message to the topic.
protected void	recvAnycastFail(Topic topic, NodeHandle failedAtNode, ScribeContent content)
void	removeChild(Topic topic, NodeHandle child) Removes a child from the given topic
protected void	removeChild(Topic topic, NodeHandle child, boolean sendDrop) Removes a child from the given topic
void	setContentDeserializer(ScribeContentDeserializer deserializer)
void	setPolicy(ScribePolicy policy) Sets the current policy for this scribe object
void	subscribe(Topic topic, ScribeClient client) Subscribes the given client to the provided topic.
void	subscribe(Topic topic, ScribeClient client, RawScribeContent content)
void	subscribe(Topic topic, ScribeClient client, RawScribeContent content, NodeHandle hint)
void	subscribe(Topic topic, ScribeClient client, ScribeContent content) Subscribes the given client to the provided topic.
void	subscribe(Topic topic, ScribeClient client, ScribeContent content, NodeHandle hint) Subscribes the given client to the provided topic.
Topic[]	topicsAsChild(NodeHandle child) This returns the topics for which the parameter 'child' is a Scribe tree child of the local node
Topic[]	topicsAsParent(NodeHandle parent) This returns the topics for which the parameter 'parent' is a Scribe tree parent of the local node
java.lang.String	toString()
void	unsubscribe(Topic topic, ScribeClient client) Unsubscribes the given client from the provided topic.getId
void	update(NodeHandle handle, boolean joined) This method is invoked to inform the application that the given node has either joined or left the neighbor set of the local node, as the set would be returned by the neighborSet call.
void	updateAllChildren(NodeHandle child, Topic t, boolean wasAdded)
void	updateAllParents(NodeHandle parent, Topic t, boolean wasAdded)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INFO_2

public static final int INFO_2

See Also:

Constant Field Values

MAINTENANCE_INTERVAL

public final int MAINTENANCE_INTERVAL

The interval with which to perform maintenance

MESSAGE_TIMEOUT

public final int MESSAGE_TIMEOUT

the timeout for a subscribe message

topics

public java.util.Hashtable<Topic,ScribeImpl.TopicManager> topics

the hashtable of topic -> TopicManager

policy

protected ScribePolicy policy

this scribe's policy

endpoint

protected Endpoint endpoint

this application's endpoint

handle

protected NodeHandle handle

the local node handle

allChildren

public java.util.HashMap<NodeHandle,java.util.List<Topic>> allChildren

This contains a mapping of child - > all topics for which the local node has this node(hashtable key) as a child

allParents

public java.util.HashMap<NodeHandle,java.util.List<Topic>> allParents

This contains a mapping of parent - > all topics for which the local node has this node(hashtable key) as a parent

Constructor Detail

ScribeImpl

public ScribeImpl(Node node,
                  java.lang.String instance)

Constructor for Scribe, using the default policy.

Parameters:

node - The node below this Scribe implementation

instance - The unique instance name of this Scribe

ScribeImpl

public ScribeImpl(Node node,
                  ScribePolicy policy,
                  java.lang.String instance)

Constructor for Scribe

Parameters:

node - The node below this Scribe implementation

policy - The policy for this Scribe

instance - The unique instance name of this Scribe

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEnvironment

public Environment getEnvironment()

Specified by:

getEnvironment in interface Scribe

getPolicy

public ScribePolicy getPolicy()

Returns the current policy for this scribe object

Specified by:

getPolicy in interface Scribe

Returns:

The current policy for this scribe

setPolicy

public void setPolicy(ScribePolicy policy)

Sets the current policy for this scribe object

Specified by:

setPolicy in interface Scribe

Parameters:

policy - The current policy for this scribe

getId

public Id getId()

Returns the Id of the local node

Returns:

The Id of the local node

numChildren

public int numChildren(Topic topic)

Specified by:

numChildren in interface Scribe

containsTopic

public boolean containsTopic(Topic topic)

Returns true if there is a TopicManager associated with this topic (any parent/children/client exists)

Specified by:

containsTopic in interface Scribe

getClients

public ScribeClient[] getClients(Topic topic)

Returns the list of clients for a given topic

Parameters:

topic - The topic to return the clients of

Returns:

The clients of the topic

getChildren

public NodeHandle[] getChildren(Topic topic)

Returns the list of children for a given topic

Specified by:

getChildren in interface Scribe

Parameters:

topic - The topic to return the children of

Returns:

The children of the topic

getParent

public NodeHandle getParent(Topic topic)

Returns the parent for a given topic

Specified by:

getParent in interface Scribe

Parameters:

topic - The topic to return the parent of

Returns:

The parent of the topic

isRoot

public boolean isRoot(Topic topic)

Returns whether or not this Scribe is the root for the given topic

Specified by:

isRoot in interface Scribe

Parameters:

topic - The topic in question

Returns:

Whether or not we are currently the root

getRoot

public NodeHandle getRoot(Topic topic)

ackMessageReceived

protected void ackMessageReceived(SubscribeAckMessage message)

Internal method which processes an ack message

Parameters:

message - The ackMessage

containsChild

public boolean containsChild(Topic topic,
                             NodeHandle child)

Specified by:

containsChild in interface Scribe

subscribe

public void subscribe(Topic topic,
                      ScribeClient client)

Subscribes the given client to the provided topic. Any message published to the topic will be delivered to the Client via the deliver() method.

Specified by:

subscribe in interface Scribe

Parameters:

topic - The topic to subscribe to

client - The client to give messages to

subscribe

public void subscribe(Topic topic,
                      ScribeClient client,
                      ScribeContent content)

Subscribes the given client to the provided topic. Any message published to the topic will be delivered to the Client via the deliver() method.

Specified by:

subscribe in interface Scribe

Parameters:

topic - The topic to subscribe to

client - The client to give messages to

content - The content to include in the subscribe

subscribe

public void subscribe(Topic topic,
                      ScribeClient client,
                      ScribeContent content,
                      NodeHandle hint)

Description copied from interface: Scribe

Subscribes the given client to the provided topic. Any message published to the topic will be delivered to the Client via the deliver() method.

Specified by:

subscribe in interface Scribe

Parameters:

topic - The topic to subscribe to

client - The client to give messages to

content - The content to include in the subscribe

hint - The first hop of the message ( Helpful to implement a centralized solution)

subscribe

public void subscribe(Topic topic,
                      ScribeClient client,
                      RawScribeContent content)

Specified by:

subscribe in interface Scribe

subscribe

public void subscribe(Topic topic,
                      ScribeClient client,
                      RawScribeContent content,
                      NodeHandle hint)

Specified by:

subscribe in interface Scribe

unsubscribe

public void unsubscribe(Topic topic,
                        ScribeClient client)

Unsubscribes the given client from the provided topic.getId

Specified by:

unsubscribe in interface Scribe

Parameters:

topic - The topic to unsubscribe from

client - The client to unsubscribe

publish

public void publish(Topic topic,
                    ScribeContent content)

Publishes the given message to the topic.

Specified by:

publish in interface Scribe

Parameters:

topic - The topic to publish to

content - The content to publish

publish

public void publish(Topic topic,
                    RawScribeContent content)

Specified by:

publish in interface Scribe

anycast

public void anycast(Topic topic,
                    ScribeContent content)

Anycasts the given content to a member of the given topic

Specified by:

anycast in interface Scribe

Parameters:

topic - The topic to anycast to

content - The content to anycast

anycast

public void anycast(Topic topic,
                    ScribeContent content,
                    NodeHandle hint)

Description copied from interface: Scribe

Anycasts the given content to a member of the given topic The hint helps us to implement centralized algorithms where the hint is the cachedRoot for the topic. Additionally it enables us to do more fancy anycasts that explore more portions of the Scribe tree

Specified by:

anycast in interface Scribe

Parameters:

topic - The topic to anycast to

content - The content to anycast

hint - the first hop of the Anycast

anycast

public void anycast(Topic topic,
                    RawScribeContent content)

Specified by:

anycast in interface Scribe

anycast

public void anycast(Topic topic,
                    RawScribeContent content,
                    NodeHandle hint)

Specified by:

anycast in interface Scribe

addChild

public void addChild(Topic topic,
                     NodeHandle child)

Adds a child to the given topic

Specified by:

addChild in interface Scribe

Parameters:

topic - The topic to add the child to

child - The child to add

addChild

protected void addChild(Topic topic,
                        NodeHandle child,
                        int id)

Adds a child to the given topic, using the specified sequence number in the ack message sent to the child.

Parameters:

topic - The topic

child - THe child to add

id - THe seuqnce number

removeChild

public void removeChild(Topic topic,
                        NodeHandle child)

Removes a child from the given topic

Specified by:

removeChild in interface Scribe

Parameters:

topic - The topic to remove the child from

child - The child to remove

removeChild

protected void removeChild(Topic topic,
                           NodeHandle child,
                           boolean sendDrop)

Removes a child from the given topic

Parameters:

topic - The topic to remove the child from

child - The child to remove

sendDrop - Whether or not to send a drop message to the chil

getTopics

public Topic[] getTopics(ScribeClient client)

Returns the list of topics the given client is subscribed to.

Specified by:

getTopics in interface Scribe

Parameters:

client - The client in question

Returns:

The list of topics

recvAnycastFail

protected void recvAnycastFail(Topic topic,
                               NodeHandle failedAtNode,
                               ScribeContent content)

updateAllChildren

public void updateAllChildren(NodeHandle child,
                              Topic t,
                              boolean wasAdded)

allChildrenContains

public boolean allChildrenContains(Topic t,
                                   NodeHandle child)

allChildrenContainsChild

public boolean allChildrenContainsChild(NodeHandle child)

updateAllParents

public void updateAllParents(NodeHandle parent,
                             Topic t,
                             boolean wasAdded)

allParentsContains

public boolean allParentsContains(Topic t,
                                  NodeHandle parent)

allParentsContainsParent

public boolean allParentsContainsParent(NodeHandle parent)

printAllParentsDataStructure

public void printAllParentsDataStructure()

printAllChildrenDataStructure

public void printAllChildrenDataStructure()

topicsAsParent

public Topic[] topicsAsParent(NodeHandle parent)

Description copied from interface: Scribe

This returns the topics for which the parameter 'parent' is a Scribe tree parent of the local node

Specified by:

topicsAsParent in interface Scribe

topicsAsChild

public Topic[] topicsAsChild(NodeHandle child)

Description copied from interface: Scribe

This returns the topics for which the parameter 'child' is a Scribe tree child of the local node

Specified by:

topicsAsChild in interface Scribe

forward

public boolean forward(RouteMessage message)

This method is invoked on applications when the underlying node is about to forward the given message with the provided target to the specified next hop. Applications can change the contents of the message, specify a different nextHop (through re-routing), or completely terminate the message.

Specified by:

forward in interface Application

Parameters:

message - The message being sent, containing an internal message along with a destination key and nodeHandle next hop.

Returns:

Whether or not to forward the message further

deliver

public void deliver(Id id,
                    Message message)

This method is called on the application at the destination node for the given id.

Specified by:

deliver in interface Application

Parameters:

id - The destination id of the message

message - The message being sent

update

public void update(NodeHandle handle,
                   boolean joined)

This method is invoked to inform the application that the given node has either joined or left the neighbor set of the local node, as the set would be returned by the neighborSet call.

Specified by:

update in interface Application

Parameters:

handle - The handle that has joined/left

joined - Whether the node has joined or left

destroy

public void destroy()

Specified by:

destroy in interface Destructable

Specified by:

destroy in interface Scribe

setContentDeserializer

public void setContentDeserializer(ScribeContentDeserializer deserializer)

Specified by:

setContentDeserializer in interface Scribe

getContentDeserializer

public ScribeContentDeserializer getContentDeserializer()

Specified by:

getContentDeserializer in interface Scribe