// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Net;

namespace TERASOLUNA.Fw.Client.Communication
{
    /// <summary>
    /// データ受信機能を提供するインターフェイスです。
    /// </summary>
    public interface IHttpReceiver
    {
        /// <summary>
        /// <paramref name="request"/> で渡された <see cref="HttpWebRequest"/> を用いて受信した
        /// データを解析し、結果を <see cref="CommunicationResult"/> に格納して返します。
        /// </summary>
        /// <remarks>
        /// <see cref="IHttpReceiver.Receive"/> を実装する際、通信中の例外は <see cref="WebException"/> と
        /// してスローし、それ以外の例外については <see cref="CommunicationException"/> としてスローするようにします。
        /// </remarks>
        /// <param name="request">
        /// 受信処理を行うリクエストオブジェクト。
        /// </param>
        /// <param name="reporter">
        /// 進行状況通知を行う <see cref="IProgressChangeReporter"/> 実装クラスのインスタンス。
        /// </param>
        /// <returns>受信結果を格納した <see cref="CommunicationResult"/>。</returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="request"/> が null 参照です。
        /// </exception>
        /// <exception cref="WebException">
        /// サーバとの通信中にエラーが発生しました。または通信がキャンセルされました。
        /// </exception>
        /// <exception cref="ServerException">
        /// 通信先のサーバでエラーが発生しました。
        /// </exception>
        /// <exception cref="CommunicationException">
        /// 受信中に内部処理でエラーが発生しました。
        /// </exception>
        CommunicationResult Receive(HttpWebRequest request,
                                    IProgressChangeReporter reporter);
    }

}
