ClientCtrl.java

/* ClientCtrl.java

	Purpose:
		
	Description:
		
	History:
		Apr 3, 2012 Created by pao

Copyright (C) 2011 Potix Corporation. All Rights Reserved.
*/
package org.zkoss.zats.mimic.impl;

import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.util.Map;

import org.zkoss.zats.mimic.Client;
import org.zkoss.zats.mimic.DesktopAgent;

/**
 * Client controller interface.
 * To provide more control of the client for developers.
 * @author pao
 */
public interface ClientCtrl {

	/**
	 * post an asynchronous update event.
	 * It will be queued until invoke flush.
	 */
	void postUpdate(String desktopId, String targetUUID, String command, Map<String, Object> data, boolean ignorable);
	
	/**
	 * post a piggyback asynchronous update event.
	 * a piggyback event's order is after normal events.
	 * It will be queued until invoke flush.
	 * @param  true indicated that it's 
	 */
	void postPiggyback(String desktopId, String targetUUID, String command, Map<String, Object> data, boolean ignorable);

	/**
	 * flush the queued AU update event including piggyback events.
	 */
	void flush(String desktopId);
	
	void destroy(DesktopAgent desktopAgent);
	
	void setDestroyListener(DestroyListener l);
	
	//to notify a client is going to be destroyed.
	interface DestroyListener {
		void willDestroy(Client conv);
	}
	
	/**
	 * open a connection with current session and cookie.
	 * @param path connect to this path
	 * @throws IOException 
	 */
	InputStream openConnection(String path) throws IOException;
	
	/**
	 * get a connection with current session and cookie.
	 * @param path connect to this path
	 * @param method HTTP method
	 */
	HttpURLConnection getConnection(String path, String method);
}