exit_node.hpp

//*****************************************************************************
// Copyright 2020 Intel 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.
//*****************************************************************************
#pragma once
#include <memory>
#include <set>
#include <string>
#include <utility>

#include "../tensorinfo.hpp"
#include "node.hpp"

namespace ovms {

extern const std::string EXIT_NODE_NAME;
extern const std::string DEFAULT_PIPELINE_NAME;

template <typename ResponseType>
class ExitNode : public Node {
    ResponseType* response;
    const tensor_map_t outputsInfo;
    bool useSharedOutputContent;
    const std::string& pipelineName;

public:
    ExitNode(ResponseType* response, const tensor_map_t& outputsInfo, std::set<std::string> gatherFromNode = {}, bool useSharedOutputContent = true, const std::string& pipelineName = DEFAULT_PIPELINE_NAME) :
        Node(EXIT_NODE_NAME, std::nullopt, std::move(gatherFromNode)),
        response(response),
        outputsInfo(outputsInfo),
        useSharedOutputContent(useSharedOutputContent),
        pipelineName(pipelineName) {
    }

    // Exit node does not have execute logic.
    // It serializes its received input tensors to proto in ::fetchResults
    Status execute(session_key_t sessionId, PipelineEventQueue& notifyEndQueue) override;

protected:
    Status fetchResults(const TensorMap& outputs);

public:
    Status fetchResults(NodeSession& nodeSession, SessionResults& nodeSessionOutputs) override;

    // Exit nodes have no dependants
    void addDependant(Node& node) override {
        throw std::logic_error("This node cannot have dependent");
    }

    std::unique_ptr<NodeSession> createNodeSession(const NodeSessionMetadata& metadata, const CollapseDetails& collapsingDetails) override;
};

}  // namespace ovms