1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
#pragma clang system_header
// 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.
// Generic Flight I/O utilities.
#pragma once
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/flight/transport.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/flight/type_fwd.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/flight/types.h"
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/flight/visibility.h"
namespace google::protobuf {
class Message;
class Timestamp;
} // namespace google::protobuf
namespace arrow20 {
class Schema;
class Status;
namespace ipc {
class Message;
} // namespace ipc
namespace flight {
// Protobuf types from Flight.proto
namespace protocol {
class Action;
class ActionType;
class BasicAuth;
class CancelFlightInfoRequest;
class CancelFlightInfoResult;
class Criteria;
class FlightData;
class FlightDescriptor;
class FlightEndpoint;
class FlightInfo;
class GetSessionOptionsRequest;
class Location;
class PollInfo;
class RenewFlightEndpointRequest;
class Result;
class SchemaResult;
class SetSessionOptionsRequest;
class SetSessionOptionsResult;
class Ticket;
class GetSessionOptionsRequest;
class GetSessionOptionsResult;
class CloseSessionRequest;
class CloseSessionResult;
} // namespace protocol
namespace pb = arrow20::flight::protocol;
namespace internal {
/// \brief The header used for transmitting authentication/authorization data.
static constexpr char kAuthHeader[] = "authorization";
ARROW_FLIGHT_EXPORT
Status SchemaToString(const Schema& schema, std::string* out);
/// \brief Wraps a protobuf message representing a Flight command in a FlightDescriptor.
///
/// A `FlightDescriptor` can carry a string representing a command in any
/// format the implementation desires. A common pattern in Flight implementations
/// is to wrap a message in a `protobuf::Any` message, which is then serialized
/// into the string of the `FlightDescriptor.`
ARROW_FLIGHT_EXPORT
Status PackProtoCommand(const google::protobuf::Message& command, FlightDescriptor* out);
/// \brief Wraps a protobuf message representing a Flight action.
///
/// A Flight action can carry a string representing an action in any format the
/// implementation desires. A common pattern in Flight implementations is to
/// wrap a message in a `protobuf::Any` message, which is then serialized into
/// the string of the `Action.`
ARROW_FLIGHT_EXPORT
Status PackProtoAction(std::string action_type, const google::protobuf::Message& action,
Action* out);
/// \brief Unpacks a protobuf message packed by PackProtoAction.
ARROW_FLIGHT_EXPORT
Status UnpackProtoAction(const Action& action, google::protobuf::Message* out);
// These functions depend on protobuf types which are not exported in the Flight DLL.
Status FromProto(const google::protobuf::Timestamp& pb_timestamp, Timestamp* timestamp);
Status FromProto(const pb::ActionType& pb_type, ActionType* type);
Status FromProto(const pb::Action& pb_action, Action* action);
Status FromProto(const pb::Result& pb_result, Result* result);
Status FromProto(const pb::CancelFlightInfoResult& pb_result,
CancelFlightInfoResult* result);
Status FromProto(const pb::Criteria& pb_criteria, Criteria* criteria);
Status FromProto(const pb::Location& pb_location, Location* location);
Status FromProto(const pb::Ticket& pb_ticket, Ticket* ticket);
Status FromProto(const pb::FlightData& pb_data, FlightDescriptor* descriptor,
std::unique_ptr<ipc::Message>* message);
Status FromProto(const pb::FlightDescriptor& pb_descr, FlightDescriptor* descr);
Status FromProto(const pb::FlightEndpoint& pb_endpoint, FlightEndpoint* endpoint);
Status FromProto(const pb::RenewFlightEndpointRequest& pb_request,
RenewFlightEndpointRequest* request);
Status FromProto(const pb::FlightInfo& pb_info, FlightInfo::Data* info);
Status FromProto(const pb::FlightInfo& pb_info, std::unique_ptr<FlightInfo>* info);
Status FromProto(const pb::PollInfo& pb_info, PollInfo* info);
Status FromProto(const pb::PollInfo& pb_info, std::unique_ptr<PollInfo>* info);
Status FromProto(const pb::CancelFlightInfoRequest& pb_request,
CancelFlightInfoRequest* request);
Status FromProto(const pb::SchemaResult& pb_result, SchemaResult* result);
Status FromProto(const pb::BasicAuth& pb_basic_auth, BasicAuth* info);
Status FromProto(const pb::SetSessionOptionsRequest& pb_request,
SetSessionOptionsRequest* request);
Status FromProto(const pb::SetSessionOptionsResult& pb_result,
SetSessionOptionsResult* result);
Status FromProto(const pb::GetSessionOptionsRequest& pb_request,
GetSessionOptionsRequest* request);
Status FromProto(const pb::GetSessionOptionsResult& pb_result,
GetSessionOptionsResult* result);
Status FromProto(const pb::CloseSessionRequest& pb_request, CloseSessionRequest* request);
Status FromProto(const pb::CloseSessionResult& pb_result, CloseSessionResult* result);
Status ToProto(const Timestamp& timestamp, google::protobuf::Timestamp* pb_timestamp);
Status ToProto(const FlightDescriptor& descr, pb::FlightDescriptor* pb_descr);
Status ToProto(const FlightEndpoint& endpoint, pb::FlightEndpoint* pb_endpoint);
Status ToProto(const RenewFlightEndpointRequest& request,
pb::RenewFlightEndpointRequest* pb_request);
Status ToProto(const FlightInfo& info, pb::FlightInfo* pb_info);
Status ToProto(const PollInfo& info, pb::PollInfo* pb_info);
Status ToProto(const CancelFlightInfoRequest& request,
pb::CancelFlightInfoRequest* pb_request);
Status ToProto(const ActionType& type, pb::ActionType* pb_type);
Status ToProto(const Action& action, pb::Action* pb_action);
Status ToProto(const Result& result, pb::Result* pb_result);
Status ToProto(const CancelFlightInfoResult& result,
pb::CancelFlightInfoResult* pb_result);
Status ToProto(const Criteria& criteria, pb::Criteria* pb_criteria);
Status ToProto(const Location& location, pb::Location* pb_location);
Status ToProto(const SchemaResult& result, pb::SchemaResult* pb_result);
Status ToProto(const Ticket& ticket, pb::Ticket* pb_ticket);
Status ToProto(const BasicAuth& basic_auth, pb::BasicAuth* pb_basic_auth);
Status ToProto(const SetSessionOptionsRequest& request,
pb::SetSessionOptionsRequest* pb_request);
Status ToProto(const SetSessionOptionsResult& result,
pb::SetSessionOptionsResult* pb_result);
Status ToProto(const GetSessionOptionsRequest& request,
pb::GetSessionOptionsRequest* pb_request);
Status ToProto(const GetSessionOptionsResult& result,
pb::GetSessionOptionsResult* pb_result);
Status ToProto(const CloseSessionRequest& request, pb::CloseSessionRequest* pb_request);
Status ToProto(const CloseSessionResult& result, pb::CloseSessionResult* pb_result);
Status ToPayload(const FlightDescriptor& descr, std::shared_ptr<Buffer>* out);
// We want to reuse RecordBatchStreamReader's implementation while
// (1) Adapting it to the Flight message format
// (2) Allowing pure-metadata messages before data is sent
// (3) Reusing the reader implementation between DoGet and DoExchange.
// To do this, we wrap the transport-level reader in a peekable
// iterator. The Flight reader can then peek at the message to
// determine whether it has application metadata or not, and pass the
// message to RecordBatchStreamReader as appropriate.
class PeekableFlightDataReader {
public:
explicit PeekableFlightDataReader(TransportDataStream* stream)
: stream_(stream), peek_(), finished_(false), valid_(false) {}
void Peek(internal::FlightData** out) {
*out = nullptr;
if (finished_) {
return;
}
if (EnsurePeek()) {
*out = &peek_;
}
}
void Next(internal::FlightData** out) {
Peek(out);
valid_ = false;
}
/// \brief Peek() until the first data message.
///
/// After this is called, either this will return \a false, or the
/// next result of \a Peek and \a Next will contain Arrow data.
bool SkipToData() {
FlightData* data;
while (true) {
Peek(&data);
if (!data) {
return false;
}
if (data->metadata) {
return true;
}
Next(&data);
}
}
private:
bool EnsurePeek() {
if (finished_ || valid_) {
return valid_;
}
if (!stream_->ReadData(&peek_)) {
finished_ = true;
valid_ = false;
} else {
valid_ = true;
}
return valid_;
}
internal::TransportDataStream* stream_;
internal::FlightData peek_;
bool finished_;
bool valid_;
};
} // namespace internal
} // namespace flight
} // namespace arrow20
|
