// Copyright (C) 2010, 2011, 2012, 2013 GlavSoft LLC.
// All rights reserved.
//
//-------------------------------------------------------------------------
// This file is part of the TightVNC software.  Please visit our Web site:
//
//                       http://www.tightvnc.com/
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//-------------------------------------------------------------------------
//

package com.glavsoft.rfb.protocol;

import com.glavsoft.rfb.IPasswordRetriever;
import com.glavsoft.rfb.client.ClientToServerMessage;
import com.glavsoft.rfb.encoding.PixelFormat;
import com.glavsoft.rfb.protocol.state.ProtocolState;
import com.glavsoft.transport.Reader;
import com.glavsoft.transport.Writer;

public interface ProtocolContext {

	void changeStateTo(ProtocolState state);

	IPasswordRetriever getPasswordRetriever();

	ProtocolSettings getSettings();

    Writer getWriter();
	Reader getReader();
	
	byte[] getInitData();

	int getFbWidth();
	void setFbWidth(int frameBufferWidth);

	int getFbHeight();
	void setFbHeight(int frameBufferHeight);

	PixelFormat getPixelFormat();
	void setPixelFormat(PixelFormat pixelFormat);

	void setRemoteDesktopName(String name);

	void sendMessage(ClientToServerMessage message);

	String getRemoteDesktopName();

	void sendRefreshMessage();
	
	void cleanUpSession(String message);

    void setTight(boolean isTight);
	boolean isTight();

    void setProtocolVersion(String protocolVersion);
    String getProtocolVersion();

	void setInitData(byte[] initData);

    void resetDecoder();

    void stopReceiverTask();
    
    /**
     * TreeVNC expension command (server to client)
     * 0   : command byte
     * 1-3 : padding
     * 4   : length U32
     * length : text
     * 
     */
    public enum TreeCommand { 
        FIND_ROOT ( 220),
        FIND_ROOT_REPLY   (221),
        WHERE_TO_CONNECT  (222), 
        CONNECT_TO  (223),
        CONNECT_TO_AS_LEADER  (224),
        LOST_PARENT  (225),
        NOT_FOUND_PARENT  (226),
        NEW_NODE  (227),
        QUIT_LOOP  (228);

        public final int cmd;
        TreeCommand(int cmd) {
            this.cmd = cmd;
        }

        public static TreeCommand create(int i) {
            switch (i) {
            case 220: return FIND_ROOT ;
            case 221: return FIND_ROOT_REPLY;
            case 222: return WHERE_TO_CONNECT;
            case 223: return CONNECT_TO ;
            case 224: return CONNECT_TO_AS_LEADER  ;
            case 225: return LOST_PARENT ;
            case 226: return NOT_FOUND_PARENT ;
            case 227: return NEW_NODE ;
            case 228: default:
                return QUIT_LOOP; 
            }
        }
    }

}