blob: 22cf383883a4f4ddfa5fabdf0591680f4cb22ae7 [file] [log] [blame]
David Reiss5ddabb82010-10-06 17:09:37 +00001/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20#ifndef _THRIFT_ASYNC_TASYNCCHANNEL_H_
21#define _THRIFT_ASYNC_TASYNCCHANNEL_H_ 1
22
cyy316723a2019-01-05 16:35:14 +080023#include <functional>
24#include <memory>
Roger Meier49ff8b12012-04-13 09:12:31 +000025#include <thrift/Thrift.h>
David Reiss5ddabb82010-10-06 17:09:37 +000026
Konrad Grochowski16a23a62014-11-13 15:33:38 +010027namespace apache {
28namespace thrift {
29namespace transport {
David Reiss5ddabb82010-10-06 17:09:37 +000030class TMemoryBuffer;
Konrad Grochowski16a23a62014-11-13 15:33:38 +010031}
32}
33}
David Reiss5ddabb82010-10-06 17:09:37 +000034
Konrad Grochowski16a23a62014-11-13 15:33:38 +010035namespace apache {
36namespace thrift {
37namespace async {
David Reiss5ddabb82010-10-06 17:09:37 +000038using apache::thrift::transport::TMemoryBuffer;
39
David Reiss5ddabb82010-10-06 17:09:37 +000040class TAsyncChannel {
Konrad Grochowski16a23a62014-11-13 15:33:38 +010041public:
cyy316723a2019-01-05 16:35:14 +080042 typedef std::function<void()> VoidCallback;
David Reiss5ddabb82010-10-06 17:09:37 +000043
Sebastian Zenker042580f2019-01-29 15:48:12 +010044 virtual ~TAsyncChannel() = default;
David Reiss5ddabb82010-10-06 17:09:37 +000045
46 // is the channel in a good state?
47 virtual bool good() const = 0;
48 virtual bool error() const = 0;
49 virtual bool timedOut() const = 0;
50
51 /**
52 * Send a message over the channel.
David Reiss5ddabb82010-10-06 17:09:37 +000053 */
Jake Farrell2cb39132011-08-29 18:34:41 +000054 virtual void sendMessage(const VoidCallback& cob,
Konrad Grochowski16a23a62014-11-13 15:33:38 +010055 apache::thrift::transport::TMemoryBuffer* message) = 0;
David Reiss5ddabb82010-10-06 17:09:37 +000056
57 /**
58 * Receive a message from the channel.
David Reiss5ddabb82010-10-06 17:09:37 +000059 */
Jake Farrell2cb39132011-08-29 18:34:41 +000060 virtual void recvMessage(const VoidCallback& cob,
Konrad Grochowski16a23a62014-11-13 15:33:38 +010061 apache::thrift::transport::TMemoryBuffer* message) = 0;
David Reiss5ddabb82010-10-06 17:09:37 +000062
63 /**
64 * Send a message over the channel and receive a response.
David Reiss5ddabb82010-10-06 17:09:37 +000065 */
Roger Meier285cfaa2011-07-28 17:51:36 +000066 virtual void sendAndRecvMessage(const VoidCallback& cob,
Konrad Grochowski16a23a62014-11-13 15:33:38 +010067 apache::thrift::transport::TMemoryBuffer* sendBuf,
68 apache::thrift::transport::TMemoryBuffer* recvBuf);
David Reiss5ddabb82010-10-06 17:09:37 +000069};
Konrad Grochowski16a23a62014-11-13 15:33:38 +010070}
71}
72} // apache::thrift::async
David Reiss5ddabb82010-10-06 17:09:37 +000073
74#endif // #ifndef _THRIFT_ASYNC_TASYNCCHANNEL_H_