package net.floodlightcontroller.mastership;

import java.util.Collection;

import net.floodlightcontroller.core.module.IFloodlightService;

//Will change to something like IRegistryService
public interface IMastershipService extends IFloodlightService {
	
	// Callback for all mastership changes. 
	// Change callback is called when mastership is acquired or released
	public interface MastershipCallback {
		public void changeCallback(long dpid, boolean isMaster);
	}
	
	// Acquire mastership for a switch. 
	public void acquireMastership(long dpid, MastershipCallback cb) throws Exception;
	
	// Release mastership for a switch
	public void releaseMastership(long dpid);
	
	// Check if I am the master of a switch. This is a nonblocking call that checks if the caller is a 
	public boolean amMaster(long dpid);
	
	// Set/Get mastership identifier.
	// This is typically a unique identifier of the controller that does not change across restarts
	public void setMastershipId (String id);
	public String getMastershipId ();
	
	/**
	 * Register a controller to the ONOS cluster
	 * @param controller A string identifying the controller and (possibly) how to talk to it.
	 * (We will have to develop a convention for this - most likely hostname:port)
	 */
	public void registerController(String controllerId) throws RegistryException;
	
	/**
	 * Get all controllers in the cluster
	 * @return
	 */
	public Collection<String> getAllControllers() throws RegistryException;
	
	
	public String getControllerForSwitch(long dpid) throws RegistryException;
	
	public Collection<Long> getSwitchesControlledByController(String controllerId);
}