StreamLayerReadExample.h

/*
 * Copyright (C) 2019-2020 HERE Europe B.V.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */

#pragma once

#include "Examples.h"

#include <olp/dataservice/read/SubscribeRequest.h>

/**
 * @brief Dataservice read from stream layer example. Authenticate client using
 * access key id and secret. If used parallel mode create threads, if serial use
 * current thread. Create a subscription. Poll data and then unsubscribe.
 * @param access_key here.access.key.id and here.access.key.secret.
 * @param catalog The HERE Resource Name (HRN) of the catalog from which you
 * want to read data.
 * @param layer_id The layer ID of the catalog.
 * @param subscription_mode The type of client subscription.
 * @return 0 on success, -1 otherwise.
 */
int RunStreamLayerExampleRead(
    const AccessKey& access_key, const std::string& catalog,
    const std::string& layer_id,
    olp::dataservice::read::SubscribeRequest::SubscriptionMode
        subscription_mode = olp::dataservice::read::SubscribeRequest::
            SubscriptionMode::kSerial);