/*******************************************************************************

"FreePastry" Peer-to-Peer Application Development Substrate

Copyright 2002-2007, Rice University. Copyright 2006-2007, Max Planck Institute 
for Software Systems.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

- Neither the name of Rice  University (RICE), Max Planck Institute for Software 
Systems (MPI-SWS) nor the names of its contributors may be used to endorse or 
promote products derived from this software without specific prior written 
permission.

This software is provided by RICE, MPI-SWS and the contributors on an "as is" 
basis, without any representations or warranties of any kind, express or implied 
including, but not limited to, representations or warranties of 
non-infringement, merchantability or fitness for a particular purpose. In no 
event shall RICE, MPI-SWS or contributors be liable for any direct, indirect, 
incidental, special, exemplary, or consequential damages (including, but not 
limited to, procurement of substitute goods or services; loss of use, data, or 
profits; or business interruption) however caused and on any theory of 
liability, whether in contract, strict liability, or tort (including negligence
or otherwise) arising in any way out of the use of this software, even if 
advised of the possibility of such damage.

*******************************************************************************/ 

package rice.p2p.scribe.messaging;

import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import rice.*;
import rice.p2p.commonapi.*;
import rice.p2p.commonapi.rawserialization.*;
import rice.p2p.scribe.*;
import rice.p2p.scribe.rawserialization.ScribeContentDeserializer;

/**
 * @(#) SubscribeLostMessage.java
 *
 * The ack for a subscribe message.
 *
 * @version $Id: SubscribeLostMessage.java 3653 2007-03-27 18:39:52Z jeffh $
 *
 * @author Alan Mislove
 */
public class SubscribeLostMessage implements Message {

  protected Set<Topic> topics;
  protected int id;
  CancellableTask task;    
  ScribeMultiClient client;
  
  /**
   * Constructor which takes a unique integer Id
   *
   * @param id The unique id
   * @param source The source address
   * @param dest The destination address
   */
  public SubscribeLostMessage(NodeHandle source, Collection<Topic> topics, int id, ScribeMultiClient client) {
    this.topics = new HashSet<Topic>(topics);
    this.id = id;
    this.client = client;
  }
  
  public ScribeMultiClient getClient() {
    return client;
  }
  
  public Collection<Topic> getTopics() {
    return topics; 
  }
  
  public int getId() {
    return id; 
  }

  public int getPriority() {
    return DEFAULT_PRIORITY;
  }

  public void putTask(CancellableTask task) {
    this.task = task;
  }
  
  public void cancel() {
    task.cancel(); 
  }
  
  /**
   * @return true if we have successfully subscribed to 
   * all topics, in which case, you should cancel the 
   * message and remove it from the table
   */
  public boolean topicsAcked(Collection<Topic> topic) {
    topics.removeAll(topic);
    return topics.isEmpty();
  }
}

