cpp-httplib v0.42.0
DRAFT

C11. 進捗コールバックを使う

ダウンロードやアップロードの進捗を表示したいときは、DownloadProgressまたはUploadProgressコールバックを渡します。どちらも(current, total)の2引数を取る関数オブジェクトです。

ダウンロードの進捗

httplib::Client cli("http://localhost:8080");

auto res = cli.Get("/large-file",
  [](size_t current, size_t total) {
    auto percent = (total > 0) ? (current * 100 / total) : 0;
    std::cout << "\rDownloading: " << percent << "% ("
              << current << "/" << total << ")" << std::flush;
    return true; // falseを返すとダウンロードを中止
  });
std::cout << std::endl;

httplib::Client cli("http://localhost:8080");

auto res = cli.Get("/large-file",
  [](size_t current, size_t total) {
    auto percent = (total > 0) ? (current * 100 / total) : 0;
    std::cout << "\rDownloading: " << percent << "% ("
              << current << "/" << total << ")" << std::flush;
    return true; // falseを返すとダウンロードを中止
  });
std::cout << std::endl;

コールバックはデータを受信するたびに呼ばれます。totalはContent-Lengthから取得した値で、サーバーが送ってこない場合は0になることがあります。その場合は進捗率が計算できないので、受信済みバイト数だけを表示するのが無難です。

アップロードの進捗

アップロード側も同じ形です。Post()やPut()の最後の引数にUploadProgressを渡します。

httplib::Client cli("http://localhost:8080");

std::string body = load_large_body();

auto res = cli.Post("/upload", body, "application/octet-stream",
  [](size_t current, size_t total) {
    auto percent = current * 100 / total;
    std::cout << "\rUploading: " << percent << "%" << std::flush;
    return true;
  });
std::cout << std::endl;

httplib::Client cli("http://localhost:8080");

std::string body = load_large_body();

auto res = cli.Post("/upload", body, "application/octet-stream",
  [](size_t current, size_t total) {
    auto percent = current * 100 / total;
    std::cout << "\rUploading: " << percent << "%" << std::flush;
    return true;
  });
std::cout << std::endl;

中断する

コールバックからfalseを返すと、転送を中止できます。UI側で「キャンセル」ボタンが押されたらfalseを返す、といった使い方ができます。

std::atomic<bool> cancelled{false};

auto res = cli.Get("/large-file",
  [&](size_t current, size_t total) {
    return !cancelled.load();
  });

std::atomic<bool> cancelled{false};

auto res = cli.Get("/large-file",
  [&](size_t current, size_t total) {
    return !cancelled.load();
  });

Note: ContentReceiverと進捗コールバックは同時に使えます。ファイルに書き出しながら進捗を表示したいときは、両方を渡しましょう。

ファイル保存と組み合わせる具体例はC01. レスポンスボディを取得する / ファイルに保存するも参照してください。

ESC