123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- /*
- * MIT License
- *
- * Copyright (c) 2019 Alexey Edelev <semlanik@gmail.com>
- *
- * This file is part of QtProtobuf project https://git.semlanik.org/semlanik/qtprotobuf
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this
- * software and associated documentation files (the "Software"), to deal in the Software
- * without restriction, including without limitation the rights to use, copy, modify,
- * merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following
- * conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies
- * or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
- * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
- * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
- * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE.
- */
- #pragma once //QAbstractGrpcChannel
- #include <QString>
- #include <QByteArray>
- #include <functional>
- #include <memory>
- #include "qgrpcstatus.h"
- #include "qtgrpcglobal.h"
- namespace QtProtobuf {
- class QGrpcAsyncReply;
- class QAbstractGrpcClient;
- class QAbstractProtobufSerializer;
- /*!
- * \ingroup QtGrpc
- * \brief The QAbstractGrpcChannel class is interface that represents common gRPC channel functionality.
- * You may implement this interface to create own channels for gRPC transport.
- */
- class Q_GRPC_EXPORT QAbstractGrpcChannel
- {
- public:
- /*!
- * \brief Calls \p method synchronously with given serialized messge \p args and write result of call to \p ret.
- * \note This method is synchronous, that means it doesn't returns until call complete or aborted by timeout if it's
- * implemented in inherited channel.
- * \param[in] method remote method is called
- * \param[in] service service identified in URL path format
- * \param[in] args serialized argument message
- * \param[out] ret output bytearray to collect returned message
- * \return returns gRPC QAbstractGrpcChannel::Status code for operation
- */
- virtual QGrpcStatus call(const QString &method, const QString &service, const QByteArray &args, QByteArray &ret) = 0;
- /*!
- * \brief Calls \p method asynchronously with given serialized messge \p args. Result of method call is written to QGrpcAsyncReply.
- * \note This method is asynchronous, that means it returns control imediately after it is called.
- * \param[in] method remote method is called
- * \param[in] service service identified in URL path format
- * \param[in] args serialized argument message
- * \param[out] ret QGrpcAsyncReply that will be returned to end-point user to read data once call complete.
- * QGrpcAsyncReply lifecycle is managed by QAbstractGrpcClient only.
- * \see QGrpcAsyncReply for details
- */
- virtual void call(const QString &method, const QString &service, const QByteArray &args, QtProtobuf::QGrpcAsyncReply *ret) = 0;
- /*!
- * \brief Subscribes to server-side stream to receive updates for given \p method.
- * \param[in] method remote method is called
- * \param[in] service service identified in URL path format
- * \param[in] args serialized argument message
- * \param[in] handler callback that will be called when message recevied from the server-stream
- */
- virtual void subscribe(const QString &method, const QString &service, const QByteArray &args, QAbstractGrpcClient *client, const std::function<void(const QByteArray &)> &handler) = 0;
- virtual std::shared_ptr<QAbstractProtobufSerializer> serializer() const = 0;
- protected:
- QAbstractGrpcChannel() = default;
- virtual ~QAbstractGrpcChannel() = default;
- /*!
- * \brief aborts async call for given \p reply
- * \note by default abort is explicitly not supported by QAbstractGrpcChannel and throws assert when called
- * \param[in] reply returned by asynchronous QAbstractGrpcChannel::call() method
- */
- virtual void abort(QGrpcAsyncReply *reply) {
- Q_UNUSED(reply)
- assert("Abort is not supported by used channel");
- }
- friend class QGrpcAsyncReply;
- private:
- Q_DISABLE_COPY(QAbstractGrpcChannel)
- };
- }
|