plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IDiagnostics.java - tcf/org.eclipse.tcf - Git at Google

 /*******************************************************************************
  * Copyright (c) 2007-2019 Wind River Systems, Inc. and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     Wind River Systems - initial API and implementation
  *******************************************************************************/
 package org.eclipse.tcf.services;

 import java.math.BigDecimal;
 import java.math.BigInteger;

 import org.eclipse.tcf.protocol.IService;
 import org.eclipse.tcf.protocol.IToken;

 /**
  * This is optional service that can be implemented by a peer.
  * If implemented, the service can be used for testing of the peer and
  * communication channel functionality and reliability.
  *
  * @noimplement This interface is not intended to be implemented by clients.
  */

 public interface IDiagnostics extends IService {

     static final String NAME = "Diagnostics";

     /**
      * 'echo' command result returns same string that was given as command argument.
      * The command is used to test communication channel ability to transmit arbitrary strings in
      * both directions.
      * @param s - any string.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken echo(String s, DoneEcho done);

     /**
      * Call back interface for 'echo' command.
      */
     interface DoneEcho {
         /**
          * Called when 'echo' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param s - same string as the command argument.
          */
         void doneEcho(IToken token, Throwable error, String s);
     }

     /**
      * 'echoFP' command result returns same floating point number that was given as command argument.
      * The command is used to test communication channel ability to transmit arbitrary floating point numbers in
      * both directions.
      * @param n - any floating point number.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken echoFP(BigDecimal n, DoneEchoFP done);

     /**
      * Call back interface for 'echoFP' command.
      */
     interface DoneEchoFP {
         /**
          * Called when 'echoFP' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param n - same number as the command argument.
          */
         void doneEchoFP(IToken token, Throwable error, BigDecimal n);
     }

     /**
      * 'echoINT' command result returns same integer number that was given as command argument.
      * The command is used to test communication channel ability to transmit arbitrary integer numbers in
      * both directions.
      * @param t - number type:
      *   0 - signed, up to 32 bits
      *   1 - unsigned, up to 32 bits
      *   2 - signed, up to 64 bits
      *   3 - unsigned, up to 64 bits
      * @param n - the number.
      * @param done - command result call back object.
      * @return - pending command handle.
      * @since 1.4
      */
     IToken echoINT(int t, BigInteger n, DoneEchoINT done);

     /**
      * Call back interface for 'echoINT' command.
      * @since 1.4
      */
     interface DoneEchoINT {
         /**
          * Called when 'echoINT' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param n - same number as the command argument.
          */
         void doneEchoINT(IToken token, Throwable error, BigInteger n);
     }

     /**
      * 'echoERR' command result returns same error report that was given as command argument.
      * The command is used to test remote agent ability to receive and transmit TCF error reports.
      * @param error - an error object.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken echoERR(Throwable error, DoneEchoERR done);

     /**
      * Call back interface for 'echoERR' command.
      */
     interface DoneEchoERR {
         /**
          * Called when 'echoERR' command is done.
          * @param token - command handle.
          * @param error - communication error report or null.
          * @param error_obj - error object, should be equal to the command argument.
          * @param error_msg - error object converted to a human readable string.
          */
         void doneEchoERR(IToken token, Throwable error, Throwable error_obj, String error_msg);
     }

     /**
      * Get list of test names that are implemented by the service.
      * Clients can request remote peer to run a test from the list.
      * When started, a test performs a predefined set actions.
      * Nature of test actions is uniquely identified by test name.
      * Exact description of test actions is a contract between client and remote peer,
      * and it is not part of Diagnostics service specifications.
      * Clients should not attempt to run a test if they don't recognize the test name.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken getTestList(DoneGetTestList done);

     /**
      * Call back interface for 'getTestList' command.
      */
     interface DoneGetTestList {
         /**
          * Called when 'getTestList' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param list - names of tests that are supported by the peer.
          */
         void doneGetTestList(IToken token, Throwable error, String[] list);
     }

     /**
      * Run a test. When started, a test performs a predefined set actions.
      * Nature of test actions is uniquely identified by test name.
      * Running test usually has associated execution context ID.
      * Depending on the test, the ID can be used with services RunControl and/or Processes services to control
      * test execution, and to obtain test results.
      * @param name - test name
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken runTest(String name, DoneRunTest done);

     /**
      * Call back interface for 'runTest' command.
      */
     interface DoneRunTest {
         /**
          * Called when 'runTest' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param context_id - test execution contest ID.
          */
         void doneRunTest(IToken token, Throwable error, String context_id);
     }

     /**
      * Cancel execution of a test.
      * @param context_id - test execution context ID.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken cancelTest(String context_id, DoneCancelTest done);

     /**
      * Call back interface for 'cancelTest' command.
      */
     interface DoneCancelTest {
         /**
          * Called when 'cancelTest' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          */
         void doneCancelTest(IToken token, Throwable error);
     }

     /**
      * Get information about a symbol in a test execution context.
      * @param context_id - test execution context ID, returned by the runTest command.
      * @param symbol_name - name of the symbol
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken getSymbol(String context_id, String symbol_name, DoneGetSymbol done);

     /**
      * Call back interface for 'getSymbol' command.
      */
     interface DoneGetSymbol {
         /**
          * Called when 'getSymbol' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param symbol - symbol properties
          */
         void doneGetSymbol(IToken token, Throwable error, ISymbol symbol);
     }

     /**
      * Interface to access result value of 'getSymbol' command.
      */
     interface ISymbol {
         String getSectionName();
         Number getValue();
         boolean isUndef();
         boolean isCommon();
         boolean isGlobal();
         boolean isLocal();
         boolean isAbs();
     }

     /**
      * Create a pair of virtual streams, @see IStreams service.
      * Remote ends of the streams are connected together, so any data sent into 'inp' stream
      * will become available for reading from 'out' stream.
      * The command is used for testing virtual streams.
      * @param inp_buf_size - buffer size in bytes of the input stream.
      * @param out_buf_size - buffer size in bytes of the output stream.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken createTestStreams(int inp_buf_size, int out_buf_size, DoneCreateTestStreams done);

     /**
      * Call back interface for 'createTestStreams' command.
      */
     interface DoneCreateTestStreams {

         /**
          * Called when 'createTestStreams' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          * @param inp_id - the input stream ID.
          * @param out_id - the output stream ID.
          */
         void doneCreateTestStreams(IToken token, Throwable error, String inp_id, String out_id);
     }

     /**
      * Dispose a virtual stream that was created by 'createTestStreams' command.
      * @param id - the stream ID.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken disposeTestStream(String id, DoneDisposeTestStream done);

     /**
      * Call back interface for 'disposeTestStream' command.
      */
     interface DoneDisposeTestStream {

         /**
          * Called when 'createTestStreams' command is done.
          * @param token - command handle.
          * @param error - error object or null.
          */
         void doneDisposeTestStream(IToken token, Throwable error);
     }

     /**
      * Send a command that is not implemented by peer.
      * Used to test handling of 'N' messages by communication channel.
      * @param done - command result call back object.
      * @return - pending command handle.
      */
     IToken not_implemented_command(DoneNotImplementedCommand done);

     interface DoneNotImplementedCommand {

         /**
          * Called when 'not_implemented_command' command is done.
          * @param token - command handle.
          * @param error - error object.
          */
         void doneNotImplementedCommand(IToken token, Throwable error);
     }
 }
	/*******************************************************************************
	* Copyright (c) 2007-2019 Wind River Systems, Inc. and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* Wind River Systems - initial API and implementation
	*******************************************************************************/
	package org.eclipse.tcf.services;

	import java.math.BigDecimal;
	import java.math.BigInteger;

	import org.eclipse.tcf.protocol.IService;
	import org.eclipse.tcf.protocol.IToken;

	/**
	* This is optional service that can be implemented by a peer.
	* If implemented, the service can be used for testing of the peer and
	* communication channel functionality and reliability.
	*
	* @noimplement This interface is not intended to be implemented by clients.
	*/

	public interface IDiagnostics extends IService {

	static final String NAME = "Diagnostics";

	/**
	* 'echo' command result returns same string that was given as command argument.
	* The command is used to test communication channel ability to transmit arbitrary strings in
	* both directions.
	* @param s - any string.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken echo(String s, DoneEcho done);

	/**
	* Call back interface for 'echo' command.
	*/
	interface DoneEcho {
	/**
	* Called when 'echo' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param s - same string as the command argument.
	*/
	void doneEcho(IToken token, Throwable error, String s);
	}

	/**
	* 'echoFP' command result returns same floating point number that was given as command argument.
	* The command is used to test communication channel ability to transmit arbitrary floating point numbers in
	* both directions.
	* @param n - any floating point number.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken echoFP(BigDecimal n, DoneEchoFP done);

	/**
	* Call back interface for 'echoFP' command.
	*/
	interface DoneEchoFP {
	/**
	* Called when 'echoFP' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param n - same number as the command argument.
	*/
	void doneEchoFP(IToken token, Throwable error, BigDecimal n);
	}

	/**
	* 'echoINT' command result returns same integer number that was given as command argument.
	* The command is used to test communication channel ability to transmit arbitrary integer numbers in
	* both directions.
	* @param t - number type:
	* 0 - signed, up to 32 bits
	* 1 - unsigned, up to 32 bits
	* 2 - signed, up to 64 bits
	* 3 - unsigned, up to 64 bits
	* @param n - the number.
	* @param done - command result call back object.
	* @return - pending command handle.
	* @since 1.4
	*/
	IToken echoINT(int t, BigInteger n, DoneEchoINT done);

	/**
	* Call back interface for 'echoINT' command.
	* @since 1.4
	*/
	interface DoneEchoINT {
	/**
	* Called when 'echoINT' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param n - same number as the command argument.
	*/
	void doneEchoINT(IToken token, Throwable error, BigInteger n);
	}

	/**
	* 'echoERR' command result returns same error report that was given as command argument.
	* The command is used to test remote agent ability to receive and transmit TCF error reports.
	* @param error - an error object.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken echoERR(Throwable error, DoneEchoERR done);

	/**
	* Call back interface for 'echoERR' command.
	*/
	interface DoneEchoERR {
	/**
	* Called when 'echoERR' command is done.
	* @param token - command handle.
	* @param error - communication error report or null.
	* @param error_obj - error object, should be equal to the command argument.
	* @param error_msg - error object converted to a human readable string.
	*/
	void doneEchoERR(IToken token, Throwable error, Throwable error_obj, String error_msg);
	}

	/**
	* Get list of test names that are implemented by the service.
	* Clients can request remote peer to run a test from the list.
	* When started, a test performs a predefined set actions.
	* Nature of test actions is uniquely identified by test name.
	* Exact description of test actions is a contract between client and remote peer,
	* and it is not part of Diagnostics service specifications.
	* Clients should not attempt to run a test if they don't recognize the test name.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken getTestList(DoneGetTestList done);

	/**
	* Call back interface for 'getTestList' command.
	*/
	interface DoneGetTestList {
	/**
	* Called when 'getTestList' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param list - names of tests that are supported by the peer.
	*/
	void doneGetTestList(IToken token, Throwable error, String[] list);
	}

	/**
	* Run a test. When started, a test performs a predefined set actions.
	* Nature of test actions is uniquely identified by test name.
	* Running test usually has associated execution context ID.
	* Depending on the test, the ID can be used with services RunControl and/or Processes services to control
	* test execution, and to obtain test results.
	* @param name - test name
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken runTest(String name, DoneRunTest done);

	/**
	* Call back interface for 'runTest' command.
	*/
	interface DoneRunTest {
	/**
	* Called when 'runTest' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param context_id - test execution contest ID.
	*/
	void doneRunTest(IToken token, Throwable error, String context_id);
	}

	/**
	* Cancel execution of a test.
	* @param context_id - test execution context ID.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken cancelTest(String context_id, DoneCancelTest done);

	/**
	* Call back interface for 'cancelTest' command.
	*/
	interface DoneCancelTest {
	/**
	* Called when 'cancelTest' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	*/
	void doneCancelTest(IToken token, Throwable error);
	}

	/**
	* Get information about a symbol in a test execution context.
	* @param context_id - test execution context ID, returned by the runTest command.
	* @param symbol_name - name of the symbol
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken getSymbol(String context_id, String symbol_name, DoneGetSymbol done);

	/**
	* Call back interface for 'getSymbol' command.
	*/
	interface DoneGetSymbol {
	/**
	* Called when 'getSymbol' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param symbol - symbol properties
	*/
	void doneGetSymbol(IToken token, Throwable error, ISymbol symbol);
	}

	/**
	* Interface to access result value of 'getSymbol' command.
	*/
	interface ISymbol {
	String getSectionName();
	Number getValue();
	boolean isUndef();
	boolean isCommon();
	boolean isGlobal();
	boolean isLocal();
	boolean isAbs();
	}

	/**
	* Create a pair of virtual streams, @see IStreams service.
	* Remote ends of the streams are connected together, so any data sent into 'inp' stream
	* will become available for reading from 'out' stream.
	* The command is used for testing virtual streams.
	* @param inp_buf_size - buffer size in bytes of the input stream.
	* @param out_buf_size - buffer size in bytes of the output stream.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken createTestStreams(int inp_buf_size, int out_buf_size, DoneCreateTestStreams done);

	/**
	* Call back interface for 'createTestStreams' command.
	*/
	interface DoneCreateTestStreams {

	/**
	* Called when 'createTestStreams' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	* @param inp_id - the input stream ID.
	* @param out_id - the output stream ID.
	*/
	void doneCreateTestStreams(IToken token, Throwable error, String inp_id, String out_id);
	}

	/**
	* Dispose a virtual stream that was created by 'createTestStreams' command.
	* @param id - the stream ID.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken disposeTestStream(String id, DoneDisposeTestStream done);

	/**
	* Call back interface for 'disposeTestStream' command.
	*/
	interface DoneDisposeTestStream {

	/**
	* Called when 'createTestStreams' command is done.
	* @param token - command handle.
	* @param error - error object or null.
	*/
	void doneDisposeTestStream(IToken token, Throwable error);
	}

	/**
	* Send a command that is not implemented by peer.
	* Used to test handling of 'N' messages by communication channel.
	* @param done - command result call back object.
	* @return - pending command handle.
	*/
	IToken not_implemented_command(DoneNotImplementedCommand done);

	interface DoneNotImplementedCommand {

	/**
	* Called when 'not_implemented_command' command is done.
	* @param token - command handle.
	* @param error - error object.
	*/
	void doneNotImplementedCommand(IToken token, Throwable error);
	}
	}