import { TimeRange, Uri } from '../baseframework';
import { AsyncCallback, IAsyncResult } from './AsyncResultSupport';
import { ICommunicationObject } from './CommunicationSupport';
import { EndpointAddress } from './EndpointAddress';
import { Message } from './Message';

/**
 *  Base class for communication channels
 *
 * @export
 * @interface IRequestChannel
 * @extends ICommunicationObject
 * @wInterface System.ServiceModel.Channels.IRequestChannel
 */
export interface IRequestChannel extends ICommunicationObject {
  /**
   * Service Uri
   *
   * @memberof IRequestChannel
   */
  Via: Uri;

  /**
   * Service Endpoint address
   *
   * @memberof IRequestChannel
   */
  RemoteAddress: EndpointAddress;

  /**
   * Initiates the services request
   *
   * @param {Message} message Request message
   * @param {AsyncCallback} callback
   * @param {any} state
   * @memberof IRequestChannel
   * @wIgnore
   */
  BeginRequest(message: Message, callback: AsyncCallback, state: any);

  /**
   * Initiates the services request
   *
   * @param {Message} message Request message
   * @param {AsyncCallback} callback
   * @param {any} state
   * @memberof IRequestChannel
   * @wIgnore
   */
  BeginRequestWithTimeout(
    message: Message,
    timeout: TimeRange,
    callback: AsyncCallback,
    state: any
  );

  /**
   * Ends the services request
   *
   * @param {IAsyncResult} resul Result message
   * @memberof IRequestChannel
   * @returns {any} The service result
   */
  EndRequest(result: IAsyncResult): any;

  /**
   * Aborts the services request
   *
   * @memberof IRequestChannel
   * @wIgnore
   */
  Abort();
}