/* * * Copyright 2014, Google Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following disclaimer * in the documentation and/or other materials provided with the * distribution. * * Neither the name of Google Inc. nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ #ifndef __GRPCPP_STREAM_H__ #define __GRPCPP_STREAM_H__ #include #include #include #include #include namespace grpc { // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE // DELETE DELETE DELETE class StreamContextInterface { public: template bool Write(T, bool); template void Start(T); template bool Read(T); google::protobuf::Message *request(); }; // Common interface for all client side streaming. class ClientStreamingInterface { public: virtual ~ClientStreamingInterface() {} // Wait until the stream finishes, and return the final status. When the // client side declares it has no more message to send, either implicitly or // by calling WritesDone, it needs to make sure there is no more message to // be received from the server, either implicitly or by getting a false from // a Read(). Otherwise, this implicitly cancels the stream. virtual Status Finish() = 0; }; // An interface that yields a sequence of R messages. template class ReaderInterface { public: virtual ~ReaderInterface() {} // Blocking read a message and parse to msg. Returns true on success. // The method returns false when there will be no more incoming messages, // either because the other side has called WritesDone or the stream has // failed (or been cancelled). virtual bool Read(R* msg) = 0; }; // An interface that can be fed a sequence of W messages. template class WriterInterface { public: virtual ~WriterInterface() {} // Blocking write msg to the stream. Returns true on success. // Returns false when the stream has been closed. virtual bool Write(const W& msg) = 0; }; template class ClientReader final : public ClientStreamingInterface, public ReaderInterface { public: // Blocking create a stream and write the first request out. ClientReader(ChannelInterface *channel, const RpcMethod &method, ClientContext *context, const google::protobuf::Message &request) : call_(channel->CreateCall(method, context, &cq_)) { CallOpBuffer buf; buf.AddSendMessage(request); buf.AddClientSendClose(); call_.PerformOps(&buf, (void *)1); cq_.Pluck((void *)1); } virtual bool Read(R *msg) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_.PerformOps(&buf, (void *)2); return cq_.Pluck((void *)2); } virtual Status Finish() override { CallOpBuffer buf; Status status; buf.AddClientRecvStatus(&status); call_.PerformOps(&buf, (void *)3); GPR_ASSERT(cq_.Pluck((void *)3)); return status; } private: CompletionQueue cq_; Call call_; }; template class ClientWriter final : public ClientStreamingInterface, public WriterInterface { public: // Blocking create a stream. ClientWriter(ChannelInterface *channel, const RpcMethod &method, ClientContext *context, google::protobuf::Message *response) : response_(response), call_(channel->CreateCall(method, context, &cq_)) {} virtual bool Write(const W& msg) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_.PerformOps(&buf, (void *)2); return cq_.Pluck((void *)2); } virtual bool WritesDone() { CallOpBuffer buf; buf.AddClientSendClose(); call_.PerformOps(&buf, (void *)3); return cq_.Pluck((void *)3); } // Read the final response and wait for the final status. virtual Status Finish() override { CallOpBuffer buf; Status status; buf.AddRecvMessage(response_); buf.AddClientRecvStatus(&status); call_.PerformOps(&buf, (void *)4); GPR_ASSERT(cq_.Pluck((void *)4)); return status; } private: google::protobuf::Message *const response_; CompletionQueue cq_; Call call_; }; // Client-side interface for bi-directional streaming. template class ClientReaderWriter final : public ClientStreamingInterface, public WriterInterface, public ReaderInterface { public: // Blocking create a stream. ClientReaderWriter(ChannelInterface *channel, const RpcMethod &method, ClientContext *context) : call_(channel->CreateCall(method, context, &cq_)) {} virtual bool Read(R *msg) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_.PerformOps(&buf, (void *)2); return cq_.Pluck((void *)2); } virtual bool Write(const W& msg) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_.PerformOps(&buf, (void *)3); return cq_.Pluck((void *)3); } virtual bool WritesDone() { CallOpBuffer buf; buf.AddClientSendClose(); call_.PerformOps(&buf, (void *)4); return cq_.Pluck((void *)4); } virtual Status Finish() override { CallOpBuffer buf; Status status; buf.AddClientRecvStatus(&status); call_.PerformOps(&buf, (void *)5); GPR_ASSERT(cq_.Pluck((void *)5)); return status; } private: CompletionQueue cq_; Call call_; }; template class ServerReader final : public ReaderInterface { public: explicit ServerReader(Call* call) : call_(call) {} virtual bool Read(R* msg) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_->PerformOps(&buf, (void *)2); return call_->cq()->Pluck((void *)2); } private: Call* call_; }; template class ServerWriter final : public WriterInterface { public: explicit ServerWriter(Call* call) : call_(call) {} virtual bool Write(const W& msg) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_->PerformOps(&buf, (void *)2); return call_->cq()->Pluck((void *)2); } private: Call* call_; }; // Server-side interface for bi-directional streaming. template class ServerReaderWriter final : public WriterInterface, public ReaderInterface { public: explicit ServerReaderWriter(Call* call) : call_(call) {} virtual bool Read(R* msg) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_->PerformOps(&buf, (void *)2); return call_->cq()->Pluck((void *)2); } virtual bool Write(const W& msg) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_->PerformOps(&buf, (void *)3); return call_->cq()->Pluck((void *)3); } private: CompletionQueue* cq_; Call* call_; }; // Async interfaces // Common interface for all client side streaming. class ClientAsyncStreamingInterface { public: virtual ~ClientAsyncStreamingInterface() {} virtual void Finish(Status* status, void* tag) = 0; }; // An interface that yields a sequence of R messages. template class AsyncReaderInterface { public: virtual ~AsyncReaderInterface() {} virtual void Read(R* msg, void* tag) = 0; }; // An interface that can be fed a sequence of W messages. template class AsyncWriterInterface { public: virtual ~Async WriterInterface() {} virtual void Write(const W& msg, void* tag) = 0; }; template class ClientAsyncReader final : public ClientAsyncStreamingInterface, public AsyncReaderInterface { public: // Blocking create a stream and write the first request out. ClientAsyncReader(ChannelInterface *channel, const RpcMethod &method, ClientContext *context, const google::protobuf::Message &request, void* tag) : call_(channel->CreateCall(method, context, &cq_)) { CallOpBuffer buf; buf.AddSendMessage(request); buf.AddClientSendClose(); call_.PerformOps(&buf, tag); } virtual void Read(R *msg, void* tag) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_.PerformOps(&buf, tag); } virtual void Finish(Status* status, void* tag) override { CallOpBuffer buf; buf.AddClientRecvStatus(status); call_.PerformOps(&buf, tag); } private: CompletionQueue cq_; Call call_; }; template class ClientWriter final : public ClientAsyncStreamingInterface, public WriterInterface { public: // Blocking create a stream. ClientAsyncWriter(ChannelInterface *channel, const RpcMethod &method, ClientContext *context, google::protobuf::Message *response) : response_(response), call_(channel->CreateCall(method, context, &cq_)) {} virtual void Write(const W& msg, void* tag) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_.PerformOps(&buf, tag); } virtual void WritesDone(void* tag) { CallOpBuffer buf; buf.AddClientSendClose(); call_.PerformOps(&buf, tag); } virtual void Finish(Status* status, void* tag) override { CallOpBuffer buf; buf.AddRecvMessage(response_); buf.AddClientRecvStatus(status); call_.PerformOps(&buf, tag); } private: google::protobuf::Message *const response_; CompletionQueue cq_; Call call_; }; // Client-side interface for bi-directional streaming. template class ClientAsyncReaderWriter final : public ClientAsyncStreamingInterface, public AsyncWriterInterface, public AsyncReaderInterface { public: ClientAsyncReaderWriter(ChannelInterface *channel, const RpcMethod &method, ClientContext *context) : call_(channel->CreateCall(method, context, &cq_)) {} virtual void Read(R *msg, void* tag) override { CallOpBuffer buf; buf.AddRecvMessage(msg); call_.PerformOps(&buf, tag); } virtual void Write(const W& msg, void* tag) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_.PerformOps(&buf, tag); } virtual bool WritesDone(void* tag) { CallOpBuffer buf; buf.AddClientSendClose(); call_.PerformOps(&buf, tag); } virtual void Finish(Status* status, void* tag) override { CallOpBuffer buf; Status status; buf.AddClientRecvStatus(status); call_.PerformOps(&buf, tag); } private: CompletionQueue cq_; Call call_; }; // TODO(yangg) Move out of stream.h template class ServerAsyncResponseWriter final { public: explicit ServerAsyncResponseWriter(Call* call) : call_(call) {} virtual void Write(const W& msg, void* tag) override { CallOpBuffer buf; buf.AddSendMessage(msg); call_->PerformOps(&buf, tag); } private: Call* call_; }; template class ServerAsyncReader : public AsyncReaderInterface { public: explicit ServerAsyncReader(Call* call) : call_(call) {} virtual void Read(R* msg, void* tag) { // TODO } private: Call* call_; }; template class ServerAsyncWriter : public AsyncWriterInterface { public: explicit ServerAsyncWriter(Call* call) : call_(call) {} virtual void Write(const W& msg, void* tag) { // TODO } private: Call* call_; }; // Server-side interface for bi-directional streaming. template class ServerAsyncReaderWriter : public AsyncWriterInterface, public AsyncReaderInterface { public: explicit ServerAsyncReaderWriter(Call* call) : call_(call) {} virtual void Read(R* msg, void* tag) { // TODO } virtual void Write(const W& msg, void* tag) { // TODO } private: Call* call_; }; } // namespace grpc #endif // __GRPCPP_STREAM_H__