martinzink commented on code in PR #1419: URL: https://github.com/apache/nifi-minifi-cpp/pull/1419#discussion_r1011661453
########## extensions/standard-processors/processors/PutTCP.cpp: ########## @@ -0,0 +1,551 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ +#include "PutTCP.h" + +#include <algorithm> +#include <utility> + +#include "range/v3/range/conversion.hpp" +#include "range/v3/view/transform.hpp" + +#include "utils/gsl.h" +#include "utils/expected.h" +#include "core/ProcessContext.h" +#include "core/ProcessSession.h" +#include "core/PropertyBuilder.h" +#include "core/Resource.h" +#include "core/logging/Logger.h" +#include "controllers/SSLContextService.h" + +#include "asio/ssl.hpp" +#include "asio/ip/tcp.hpp" +#include "asio/write.hpp" +#include "asio/high_resolution_timer.hpp" + +using asio::ip::tcp; +using TcpSocket = asio::ip::tcp::socket; +using SslSocket = asio::ssl::stream<tcp::socket>; + +using namespace std::literals::chrono_literals; + +namespace org::apache::nifi::minifi::processors { + +const core::Property PutTCP::Hostname = core::PropertyBuilder::createProperty("Hostname") + ->withDescription("The ip address or hostname of the destination.") + ->withDefaultValue("localhost") + ->isRequired(true) + ->supportsExpressionLanguage(true) + ->build(); + +const core::Property PutTCP::Port = core::PropertyBuilder::createProperty("Port") + ->withDescription("The port or service on the destination.") + ->isRequired(true) + ->supportsExpressionLanguage(true) + ->build(); + +const core::Property PutTCP::IdleConnectionExpiration = core::PropertyBuilder::createProperty("Idle Connection Expiration") + ->withDescription("The amount of time a connection should be held open without being used before closing the connection. A value of 0 seconds will disable this feature.") + ->withDefaultValue<core::TimePeriodValue>("15 seconds") + ->isRequired(true) + ->supportsExpressionLanguage(true) + ->build(); + +const core::Property PutTCP::Timeout = core::PropertyBuilder::createProperty("Timeout") + ->withDescription("The timeout for connecting to and communicating with the destination.") + ->withDefaultValue<core::TimePeriodValue>("15 seconds") + ->isRequired(true) + ->supportsExpressionLanguage(true) + ->build(); + +const core::Property PutTCP::ConnectionPerFlowFile = core::PropertyBuilder::createProperty("Connection Per FlowFile") + ->withDescription("Specifies whether to send each FlowFile's content on an individual connection.") + ->withDefaultValue(false) + ->isRequired(true) + ->supportsExpressionLanguage(false) + ->build(); + +const core::Property PutTCP::OutgoingMessageDelimiter = core::PropertyBuilder::createProperty("Outgoing Message Delimiter") + ->withDescription("Specifies the delimiter to use when sending messages out over the same TCP stream. " + "The delimiter is appended to each FlowFile message that is transmitted over the stream so that the receiver can determine when one message ends and the next message begins. " + "Users should ensure that the FlowFile content does not contain the delimiter character to avoid errors.") + ->isRequired(false) + ->supportsExpressionLanguage(true) + ->build(); + +const core::Property PutTCP::SSLContextService = core::PropertyBuilder::createProperty("SSL Context Service") + ->withDescription("The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be sent over a secure connection.") + ->isRequired(false) + ->asType<minifi::controllers::SSLContextService>() + ->build(); + +const core::Property PutTCP::MaxSizeOfSocketSendBuffer = core::PropertyBuilder::createProperty("Max Size of Socket Send Buffer") + ->withDescription("The maximum size of the socket send buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be.") + ->isRequired(false) + ->asType<core::DataSizeValue>() + ->build(); + +const core::Relationship PutTCP::Success{"success", "FlowFiles that are sent to the destination are sent out this relationship."}; +const core::Relationship PutTCP::Failure{"failure", "FlowFiles that encountered IO errors are send out this relationship."}; + +PutTCP::PutTCP(const std::string& name, const utils::Identifier& uuid) + : Processor(name, uuid) {} + +PutTCP::~PutTCP() = default; + +void PutTCP::initialize() { + setSupportedProperties(properties()); + setSupportedRelationships(relationships()); +} + +void PutTCP::notifyStop() {} + +void PutTCP::onSchedule(core::ProcessContext* const context, core::ProcessSessionFactory*) { + gsl_Expects(context); + + // if the required properties are missing or empty even before evaluating the EL expression, then we can throw in onSchedule, before we waste any flow files + if (context->getProperty(Hostname).value_or(std::string{}).empty()) { + throw Exception{ExceptionType::PROCESSOR_EXCEPTION, "missing hostname"}; + } + if (context->getProperty(Port).value_or(std::string{}).empty()) { + throw Exception{ExceptionType::PROCESSOR_EXCEPTION, "missing port"}; + } + if (auto idle_connection_expiration = context->getProperty<core::TimePeriodValue>(IdleConnectionExpiration); idle_connection_expiration && idle_connection_expiration->getMilliseconds() > 0ms) + idle_connection_expiration_ = idle_connection_expiration->getMilliseconds(); + else + idle_connection_expiration_.reset(); + + if (auto timeout = context->getProperty<core::TimePeriodValue>(Timeout); timeout && timeout->getMilliseconds() > 0ms) + timeout_ = timeout->getMilliseconds(); + else + timeout_ = 15s; + + std::string context_name; + if (context->getProperty(SSLContextService.getName(), context_name) && !IsNullOrEmpty(context_name)) + ssl_context_service_ = std::dynamic_pointer_cast<minifi::controllers::SSLContextService>(context->getControllerService(context_name)); + + delimiter_.clear(); + if (auto delimiter_str = context->getProperty(OutgoingMessageDelimiter)) { + delimiter_ = ranges::views::transform(*delimiter_str, [](char c) { return static_cast<std::byte>(c); }) | ranges::to<std::vector>(); + } Review Comment: good idea, I've changed it in https://github.com/apache/nifi-minifi-cpp/pull/1419/commits/a4becde14199ad2b8f1354de64ed7dad5b6503dd#diff-a62ddb0368e1813dff2a90fe7433e148bfc7b21b7d7ad9c8a066fd040d209ac9R139 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@nifi.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
