forked from apache/pulsar-client-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathClientConnection.cc
1947 lines (1691 loc) · 77.4 KB
/
ClientConnection.cc
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 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 "ClientConnection.h"
#include <pulsar/MessageIdBuilder.h>
#include <boost/optional.hpp>
#include <fstream>
#include "Commands.h"
#include "ConnectionPool.h"
#include "ConsumerImpl.h"
#include "ExecutorService.h"
#include "LogUtils.h"
#include "OpSendMsg.h"
#include "ProducerImpl.h"
#include "PulsarApi.pb.h"
#include "ResultUtils.h"
#include "Url.h"
#include "auth/AuthOauth2.h"
#include "auth/InitialAuthData.h"
#include "checksum/ChecksumProvider.h"
DECLARE_LOG_OBJECT()
using namespace boost::asio::ip;
namespace pulsar {
using proto::BaseCommand;
static const uint32_t DefaultBufferSize = 64 * 1024;
static const int KeepAliveIntervalInSeconds = 30;
static MessageId toMessageId(const proto::MessageIdData& messageIdData) {
return MessageIdBuilder::from(messageIdData).build();
}
// Convert error codes from protobuf to client API Result
static Result getResult(ServerError serverError, const std::string& message) {
switch (serverError) {
case UnknownError:
return ResultUnknownError;
case MetadataError:
return ResultBrokerMetadataError;
case ChecksumError:
return ResultChecksumError;
case PersistenceError:
return ResultBrokerPersistenceError;
case AuthenticationError:
return ResultAuthenticationError;
case AuthorizationError:
return ResultAuthorizationError;
case ConsumerBusy:
return ResultConsumerBusy;
case ServiceNotReady:
// If the error is not caused by a PulsarServerException, treat it as retryable.
return (message.find("PulsarServerException") == std::string::npos) ? ResultRetryable
: ResultServiceUnitNotReady;
case ProducerBlockedQuotaExceededError:
return ResultProducerBlockedQuotaExceededError;
case ProducerBlockedQuotaExceededException:
return ResultProducerBlockedQuotaExceededException;
case TopicNotFound:
return ResultTopicNotFound;
case SubscriptionNotFound:
return ResultSubscriptionNotFound;
case ConsumerNotFound:
return ResultConsumerNotFound;
case UnsupportedVersionError:
return ResultUnsupportedVersionError;
case TooManyRequests:
return ResultTooManyLookupRequestException;
case TopicTerminatedError:
return ResultTopicTerminated;
case ProducerBusy:
return ResultProducerBusy;
case InvalidTopicName:
return ResultInvalidTopicName;
case IncompatibleSchema:
return ResultIncompatibleSchema;
case ConsumerAssignError:
return ResultConsumerAssignError;
case TransactionCoordinatorNotFound:
return ResultTransactionCoordinatorNotFoundError;
case InvalidTxnStatus:
return ResultInvalidTxnStatusError;
case NotAllowedError:
return ResultNotAllowedError;
case TransactionConflict:
return ResultTransactionConflict;
case TransactionNotFound:
return ResultTransactionNotFound;
case ProducerFenced:
return ResultProducerFenced;
}
// NOTE : Do not add default case in the switch above. In future if we get new cases for
// ServerError and miss them in the switch above we would like to get notified. Adding
// return here to make the compiler happy.
return ResultUnknownError;
}
inline std::ostream& operator<<(std::ostream& os, proto::ServerError error) {
os << getResult(error, "");
return os;
}
static bool file_exists(const std::string& path) {
if (path.empty()) {
return false;
}
std::ifstream f(path);
return f.good();
}
std::atomic<int32_t> ClientConnection::maxMessageSize_{Commands::DefaultMaxMessageSize};
ClientConnection::ClientConnection(const std::string& logicalAddress, const std::string& physicalAddress,
ExecutorServicePtr executor,
const ClientConfiguration& clientConfiguration,
const AuthenticationPtr& authentication, const std::string& clientVersion,
ConnectionPool& pool, size_t poolIndex)
: operationsTimeout_(seconds(clientConfiguration.getOperationTimeoutSeconds())),
authentication_(authentication),
serverProtocolVersion_(proto::ProtocolVersion_MIN),
executor_(executor),
resolver_(executor_->createTcpResolver()),
socket_(executor_->createSocket()),
#if BOOST_VERSION >= 107000
strand_(boost::asio::make_strand(executor_->getIOService().get_executor())),
#elif BOOST_VERSION >= 106600
strand_(executor_->getIOService().get_executor()),
#else
strand_(executor_->getIOService()),
#endif
logicalAddress_(logicalAddress),
physicalAddress_(physicalAddress),
cnxString_("[<none> -> " + physicalAddress + "] "),
incomingBuffer_(SharedBuffer::allocate(DefaultBufferSize)),
connectTimeoutTask_(
std::make_shared<PeriodicTask>(*executor_, clientConfiguration.getConnectionTimeout())),
outgoingBuffer_(SharedBuffer::allocate(DefaultBufferSize)),
consumerStatsRequestTimer_(executor_->createDeadlineTimer()),
maxPendingLookupRequest_(clientConfiguration.getConcurrentLookupRequest()),
clientVersion_(clientVersion),
pool_(pool),
poolIndex_(poolIndex) {
LOG_INFO(cnxString_ << "Create ClientConnection, timeout=" << clientConfiguration.getConnectionTimeout());
if (!authentication_) {
LOG_ERROR("Invalid authentication plugin");
throw ResultAuthenticationError;
return;
}
auto oauth2Auth = std::dynamic_pointer_cast<AuthOauth2>(authentication_);
if (oauth2Auth) {
// Configure the TLS trust certs file for Oauth2
auto authData = std::dynamic_pointer_cast<AuthenticationDataProvider>(
std::make_shared<InitialAuthData>(clientConfiguration.getTlsTrustCertsFilePath()));
oauth2Auth->getAuthData(authData);
}
if (clientConfiguration.isUseTls()) {
#if BOOST_VERSION >= 105400
boost::asio::ssl::context ctx(boost::asio::ssl::context::tlsv12_client);
#else
boost::asio::ssl::context ctx(executor_->getIOService(), boost::asio::ssl::context::tlsv1_client);
#endif
Url serviceUrl;
Url::parse(physicalAddress, serviceUrl);
if (clientConfiguration.isTlsAllowInsecureConnection()) {
ctx.set_verify_mode(boost::asio::ssl::context::verify_none);
isTlsAllowInsecureConnection_ = true;
} else {
ctx.set_verify_mode(boost::asio::ssl::context::verify_peer);
std::string trustCertFilePath = clientConfiguration.getTlsTrustCertsFilePath();
if (!trustCertFilePath.empty()) {
if (file_exists(trustCertFilePath)) {
ctx.load_verify_file(trustCertFilePath);
} else {
LOG_ERROR(trustCertFilePath << ": No such trustCertFile");
throw ResultAuthenticationError;
}
} else {
ctx.set_default_verify_paths();
}
}
std::string tlsCertificates = clientConfiguration.getTlsCertificateFilePath();
std::string tlsPrivateKey = clientConfiguration.getTlsPrivateKeyFilePath();
AuthenticationDataPtr authData;
if (authentication_->getAuthData(authData) == ResultOk && authData->hasDataForTls()) {
tlsCertificates = authData->getTlsCertificates();
tlsPrivateKey = authData->getTlsPrivateKey();
if (!file_exists(tlsCertificates)) {
LOG_ERROR(tlsCertificates << ": No such tlsCertificates");
throw ResultAuthenticationError;
}
if (!file_exists(tlsCertificates)) {
LOG_ERROR(tlsCertificates << ": No such tlsCertificates");
throw ResultAuthenticationError;
}
ctx.use_private_key_file(tlsPrivateKey, boost::asio::ssl::context::pem);
ctx.use_certificate_file(tlsCertificates, boost::asio::ssl::context::pem);
} else {
if (file_exists(tlsPrivateKey) && file_exists(tlsCertificates)) {
ctx.use_private_key_file(tlsPrivateKey, boost::asio::ssl::context::pem);
ctx.use_certificate_file(tlsCertificates, boost::asio::ssl::context::pem);
}
}
tlsSocket_ = ExecutorService::createTlsSocket(socket_, ctx);
if (!clientConfiguration.isTlsAllowInsecureConnection() && clientConfiguration.isValidateHostName()) {
LOG_DEBUG("Validating hostname for " << serviceUrl.host() << ":" << serviceUrl.port());
tlsSocket_->set_verify_callback(boost::asio::ssl::rfc2818_verification(serviceUrl.host()));
}
LOG_DEBUG("TLS SNI Host: " << serviceUrl.host());
if (!SSL_set_tlsext_host_name(tlsSocket_->native_handle(), serviceUrl.host().c_str())) {
boost::system::error_code ec{static_cast<int>(::ERR_get_error()),
boost::asio::error::get_ssl_category()};
LOG_ERROR(boost::system::system_error{ec}.what() << ": Error while setting TLS SNI");
return;
}
}
}
ClientConnection::~ClientConnection() {
LOG_INFO(cnxString_ << "Destroyed connection to " << logicalAddress_ << "-" << poolIndex_);
}
void ClientConnection::handlePulsarConnected(const proto::CommandConnected& cmdConnected) {
if (!cmdConnected.has_server_version()) {
LOG_ERROR(cnxString_ << "Server version is not set");
close();
return;
}
if (cmdConnected.has_max_message_size()) {
LOG_DEBUG("Connection has max message size setting: " << cmdConnected.max_message_size());
maxMessageSize_.store(cmdConnected.max_message_size(), std::memory_order_release);
LOG_DEBUG("Current max message size is: " << maxMessageSize_);
}
Lock lock(mutex_);
if (isClosed()) {
LOG_INFO(cnxString_ << "Connection already closed");
return;
}
state_ = Ready;
connectTimeoutTask_->stop();
serverProtocolVersion_ = cmdConnected.protocol_version();
if (serverProtocolVersion_ >= proto::v1) {
// Only send keep-alive probes if the broker supports it
keepAliveTimer_ = executor_->createDeadlineTimer();
if (keepAliveTimer_) {
keepAliveTimer_->expires_from_now(boost::posix_time::seconds(KeepAliveIntervalInSeconds));
auto weakSelf = weak_from_this();
keepAliveTimer_->async_wait([weakSelf](const boost::system::error_code&) {
auto self = weakSelf.lock();
if (self) {
self->handleKeepAliveTimeout();
}
});
}
}
lock.unlock();
connectPromise_.setValue(shared_from_this());
if (serverProtocolVersion_ >= proto::v8) {
startConsumerStatsTimer(std::vector<uint64_t>());
}
}
void ClientConnection::startConsumerStatsTimer(std::vector<uint64_t> consumerStatsRequests) {
std::vector<Promise<Result, BrokerConsumerStatsImpl>> consumerStatsPromises;
Lock lock(mutex_);
for (int i = 0; i < consumerStatsRequests.size(); i++) {
PendingConsumerStatsMap::iterator it = pendingConsumerStatsMap_.find(consumerStatsRequests[i]);
if (it != pendingConsumerStatsMap_.end()) {
LOG_DEBUG(cnxString_ << " removing request_id " << it->first
<< " from the pendingConsumerStatsMap_");
consumerStatsPromises.push_back(it->second);
pendingConsumerStatsMap_.erase(it);
} else {
LOG_DEBUG(cnxString_ << "request_id " << it->first << " already fulfilled - not removing it");
}
}
consumerStatsRequests.clear();
for (PendingConsumerStatsMap::iterator it = pendingConsumerStatsMap_.begin();
it != pendingConsumerStatsMap_.end(); ++it) {
consumerStatsRequests.push_back(it->first);
}
// If the close operation has reset the consumerStatsRequestTimer_ then the use_count will be zero
// Check if we have a timer still before we set the request timer to pop again.
if (consumerStatsRequestTimer_) {
consumerStatsRequestTimer_->expires_from_now(operationsTimeout_);
auto weakSelf = weak_from_this();
consumerStatsRequestTimer_->async_wait(
[weakSelf, consumerStatsRequests](const boost::system::error_code& err) {
auto self = weakSelf.lock();
if (self) {
self->handleConsumerStatsTimeout(err, consumerStatsRequests);
}
});
}
lock.unlock();
// Complex logic since promises need to be fulfilled outside the lock
for (int i = 0; i < consumerStatsPromises.size(); i++) {
consumerStatsPromises[i].setFailed(ResultTimeout);
LOG_WARN(cnxString_ << " Operation timedout, didn't get response from broker");
}
}
/// The number of unacknowledged probes to send before considering the connection dead and notifying the
/// application layer
typedef boost::asio::detail::socket_option::integer<IPPROTO_TCP, TCP_KEEPCNT> tcp_keep_alive_count;
/// The interval between subsequential keepalive probes, regardless of what the connection has exchanged in
/// the meantime
typedef boost::asio::detail::socket_option::integer<IPPROTO_TCP, TCP_KEEPINTVL> tcp_keep_alive_interval;
/// The interval between the last data packet sent (simple ACKs are not considered data) and the first
/// keepalive
/// probe; after the connection is marked to need keepalive, this counter is not used any further
#ifdef __APPLE__
typedef boost::asio::detail::socket_option::integer<IPPROTO_TCP, TCP_KEEPALIVE> tcp_keep_alive_idle;
#else
typedef boost::asio::detail::socket_option::integer<IPPROTO_TCP, TCP_KEEPIDLE> tcp_keep_alive_idle;
#endif
/*
* TCP Connect handler
*
* if async_connect without any error, connected_ would be set to true
* at this point the connection is deemed valid to be used by clients of this class
*/
void ClientConnection::handleTcpConnected(const boost::system::error_code& err,
tcp::resolver::iterator endpointIterator) {
if (!err) {
std::stringstream cnxStringStream;
try {
cnxStringStream << "[" << socket_->local_endpoint() << " -> " << socket_->remote_endpoint()
<< "] ";
cnxString_ = cnxStringStream.str();
} catch (const boost::system::system_error& e) {
LOG_ERROR("Failed to get endpoint: " << e.what());
close(ResultRetryable);
return;
}
if (logicalAddress_ == physicalAddress_) {
LOG_INFO(cnxString_ << "Connected to broker");
} else {
LOG_INFO(cnxString_ << "Connected to broker through proxy. Logical broker: " << logicalAddress_);
}
Lock lock(mutex_);
if (isClosed()) {
LOG_INFO(cnxString_ << "Connection already closed");
return;
}
state_ = TcpConnected;
lock.unlock();
boost::system::error_code error;
socket_->set_option(tcp::no_delay(true), error);
if (error) {
LOG_WARN(cnxString_ << "Socket failed to set tcp::no_delay: " << error.message());
}
socket_->set_option(tcp::socket::keep_alive(true), error);
if (error) {
LOG_WARN(cnxString_ << "Socket failed to set tcp::socket::keep_alive: " << error.message());
}
// Start TCP keep-alive probes after connection has been idle after 1 minute. Ideally this
// should never happen, given that we're sending our own keep-alive probes (within the TCP
// connection) every 30 seconds
socket_->set_option(tcp_keep_alive_idle(1 * 60), error);
if (error) {
LOG_DEBUG(cnxString_ << "Socket failed to set tcp_keep_alive_idle: " << error.message());
}
// Send up to 10 probes before declaring the connection broken
socket_->set_option(tcp_keep_alive_count(10), error);
if (error) {
LOG_DEBUG(cnxString_ << "Socket failed to set tcp_keep_alive_count: " << error.message());
}
// Interval between probes: 6 seconds
socket_->set_option(tcp_keep_alive_interval(6), error);
if (error) {
LOG_DEBUG(cnxString_ << "Socket failed to set tcp_keep_alive_interval: " << error.message());
}
if (tlsSocket_) {
if (!isTlsAllowInsecureConnection_) {
boost::system::error_code err;
Url service_url;
if (!Url::parse(physicalAddress_, service_url)) {
LOG_ERROR(cnxString_ << "Invalid Url, unable to parse: " << err << " " << err.message());
close();
return;
}
}
auto weakSelf = weak_from_this();
auto callback = [weakSelf](const boost::system::error_code& err) {
auto self = weakSelf.lock();
if (self) {
self->handleHandshake(err);
}
};
#if BOOST_VERSION >= 106600
tlsSocket_->async_handshake(boost::asio::ssl::stream<tcp::socket>::client,
boost::asio::bind_executor(strand_, callback));
#else
tlsSocket_->async_handshake(boost::asio::ssl::stream<tcp::socket>::client,
strand_.wrap(callback));
#endif
} else {
handleHandshake(boost::system::errc::make_error_code(boost::system::errc::success));
}
} else if (endpointIterator != tcp::resolver::iterator()) {
LOG_WARN(cnxString_ << "Failed to establish connection: " << err.message());
// The connection failed. Try the next endpoint in the list.
boost::system::error_code closeError;
socket_->close(closeError); // ignore the error of close
if (closeError) {
LOG_WARN(cnxString_ << "Failed to close socket: " << err.message());
}
connectTimeoutTask_->stop();
++endpointIterator;
if (endpointIterator != tcp::resolver::iterator()) {
LOG_DEBUG(cnxString_ << "Connecting to " << endpointIterator->endpoint() << "...");
connectTimeoutTask_->start();
tcp::endpoint endpoint = *endpointIterator;
auto weakSelf = weak_from_this();
socket_->async_connect(endpoint,
[weakSelf, endpointIterator](const boost::system::error_code& err) {
auto self = weakSelf.lock();
if (self) {
self->handleTcpConnected(err, endpointIterator);
}
});
} else {
if (err == boost::asio::error::operation_aborted) {
// TCP connect timeout, which is not retryable
close();
} else {
close(ResultRetryable);
}
}
} else {
LOG_ERROR(cnxString_ << "Failed to establish connection: " << err.message());
close(ResultRetryable);
}
}
void ClientConnection::handleHandshake(const boost::system::error_code& err) {
if (err) {
LOG_ERROR(cnxString_ << "Handshake failed: " << err.message());
close();
return;
}
bool connectingThroughProxy = logicalAddress_ != physicalAddress_;
Result result = ResultOk;
SharedBuffer buffer = Commands::newConnect(authentication_, logicalAddress_, connectingThroughProxy,
clientVersion_, result);
if (result != ResultOk) {
LOG_ERROR(cnxString_ << "Failed to establish connection: " << result);
close(result);
return;
}
// Send CONNECT command to broker
auto self = shared_from_this();
asyncWrite(buffer.const_asio_buffer(),
customAllocWriteHandler([this, self, buffer](const boost::system::error_code& err, size_t) {
handleSentPulsarConnect(err, buffer);
}));
}
void ClientConnection::handleSentPulsarConnect(const boost::system::error_code& err,
const SharedBuffer& buffer) {
if (isClosed()) {
return;
}
if (err) {
LOG_ERROR(cnxString_ << "Failed to establish connection: " << err.message());
close();
return;
}
// Schedule the reading of CONNECTED command from broker
readNextCommand();
}
void ClientConnection::handleSentAuthResponse(const boost::system::error_code& err,
const SharedBuffer& buffer) {
if (isClosed()) {
return;
}
if (err) {
LOG_WARN(cnxString_ << "Failed to send auth response: " << err.message());
close();
return;
}
}
/*
* Async method to establish TCP connection with broker
*
* tcpConnectCompletionHandler is notified when the result of this call is available.
*
*/
void ClientConnection::tcpConnectAsync() {
if (isClosed()) {
return;
}
boost::system::error_code err;
Url service_url;
if (!Url::parse(physicalAddress_, service_url)) {
LOG_ERROR(cnxString_ << "Invalid Url, unable to parse: " << err << " " << err.message());
close();
return;
}
if (service_url.protocol() != "pulsar" && service_url.protocol() != "pulsar+ssl") {
LOG_ERROR(cnxString_ << "Invalid Url protocol '" << service_url.protocol()
<< "'. Valid values are 'pulsar' and 'pulsar+ssl'");
close();
return;
}
LOG_DEBUG(cnxString_ << "Resolving " << service_url.host() << ":" << service_url.port());
tcp::resolver::query query(service_url.host(), std::to_string(service_url.port()));
auto weakSelf = weak_from_this();
resolver_->async_resolve(
query, [weakSelf](const boost::system::error_code& err, tcp::resolver::iterator iterator) {
auto self = weakSelf.lock();
if (self) {
self->handleResolve(err, iterator);
}
});
}
void ClientConnection::handleResolve(const boost::system::error_code& err,
tcp::resolver::iterator endpointIterator) {
if (err) {
LOG_ERROR(cnxString_ << "Resolve error: " << err << " : " << err.message());
close();
return;
}
auto weakSelf = weak_from_this();
connectTimeoutTask_->setCallback([weakSelf](const PeriodicTask::ErrorCode& ec) {
ClientConnectionPtr ptr = weakSelf.lock();
if (!ptr) {
// Connection was already destroyed
return;
}
if (ptr->state_ != Ready) {
LOG_ERROR(ptr->cnxString_ << "Connection was not established in "
<< ptr->connectTimeoutTask_->getPeriodMs() << " ms, close the socket");
PeriodicTask::ErrorCode err;
ptr->socket_->close(err);
if (err) {
LOG_WARN(ptr->cnxString_ << "Failed to close socket: " << err.message());
}
}
ptr->connectTimeoutTask_->stop();
});
LOG_DEBUG(cnxString_ << "Connecting to " << endpointIterator->endpoint() << "...");
connectTimeoutTask_->start();
if (endpointIterator != tcp::resolver::iterator()) {
LOG_DEBUG(cnxString_ << "Resolved hostname " << endpointIterator->host_name() //
<< " to " << endpointIterator->endpoint());
socket_->async_connect(*endpointIterator,
[weakSelf, endpointIterator](const boost::system::error_code& err) {
auto self = weakSelf.lock();
if (self) {
self->handleTcpConnected(err, endpointIterator);
}
});
} else {
LOG_WARN(cnxString_ << "No IP address found");
close();
return;
}
}
void ClientConnection::readNextCommand() {
const static uint32_t minReadSize = sizeof(uint32_t);
auto self = shared_from_this();
asyncReceive(
incomingBuffer_.asio_buffer(),
customAllocReadHandler([this, self](const boost::system::error_code& err, size_t bytesTransferred) {
handleRead(err, bytesTransferred, minReadSize);
}));
}
void ClientConnection::handleRead(const boost::system::error_code& err, size_t bytesTransferred,
uint32_t minReadSize) {
if (isClosed()) {
return;
}
// Update buffer write idx with new data
incomingBuffer_.bytesWritten(bytesTransferred);
if (err || bytesTransferred == 0) {
if (err == boost::asio::error::operation_aborted) {
LOG_DEBUG(cnxString_ << "Read operation was canceled: " << err.message());
} else if (bytesTransferred == 0 || err == boost::asio::error::eof) {
LOG_DEBUG(cnxString_ << "Server closed the connection: " << err.message());
} else {
LOG_ERROR(cnxString_ << "Read operation failed: " << err.message());
}
close(ResultDisconnected);
} else if (bytesTransferred < minReadSize) {
// Read the remaining part, use a slice of buffer to write on the next
// region
SharedBuffer buffer = incomingBuffer_.slice(bytesTransferred);
auto self = shared_from_this();
auto nextMinReadSize = minReadSize - bytesTransferred;
asyncReceive(buffer.asio_buffer(), customAllocReadHandler([this, self, nextMinReadSize](
const boost::system::error_code& err,
size_t bytesTransferred) {
handleRead(err, bytesTransferred, nextMinReadSize);
}));
} else {
processIncomingBuffer();
}
}
void ClientConnection::processIncomingBuffer() {
// Process all the available frames from the incoming buffer
while (incomingBuffer_.readableBytes() >= sizeof(uint32_t)) {
// Extract message frames from incoming buffer
// At this point we have at least 4 bytes in the buffer
uint32_t frameSize = incomingBuffer_.readUnsignedInt();
if (frameSize > incomingBuffer_.readableBytes()) {
// We don't have the entire frame yet
const uint32_t bytesToReceive = frameSize - incomingBuffer_.readableBytes();
// Rollback the reading of frameSize (when the frame will be complete,
// we'll read it again
incomingBuffer_.rollback(sizeof(uint32_t));
if (bytesToReceive > incomingBuffer_.writableBytes()) {
// Need to allocate a buffer big enough for the frame
uint32_t newBufferSize = std::max<uint32_t>(DefaultBufferSize, frameSize + sizeof(uint32_t));
incomingBuffer_ = SharedBuffer::copyFrom(incomingBuffer_, newBufferSize);
}
auto self = shared_from_this();
asyncReceive(
incomingBuffer_.asio_buffer(),
customAllocReadHandler([this, self, bytesToReceive](const boost::system::error_code& err,
size_t bytesTransferred) {
handleRead(err, bytesTransferred, bytesToReceive);
}));
return;
}
// At this point, we have at least one complete frame available in the buffer
uint32_t cmdSize = incomingBuffer_.readUnsignedInt();
proto::BaseCommand incomingCmd;
if (!incomingCmd.ParseFromArray(incomingBuffer_.data(), cmdSize)) {
LOG_ERROR(cnxString_ << "Error parsing protocol buffer command");
close(ResultDisconnected);
return;
}
incomingBuffer_.consume(cmdSize);
if (incomingCmd.type() == BaseCommand::MESSAGE) {
// Parse message metadata and extract payload
proto::MessageMetadata msgMetadata;
proto::BrokerEntryMetadata brokerEntryMetadata;
// read checksum
uint32_t remainingBytes = frameSize - (cmdSize + 4);
auto readerIndex = incomingBuffer_.readerIndex();
if (incomingBuffer_.readUnsignedShort() == Commands::magicBrokerEntryMetadata) {
// broker entry metadata is present
uint32_t brokerEntryMetadataSize = incomingBuffer_.readUnsignedInt();
if (!brokerEntryMetadata.ParseFromArray(incomingBuffer_.data(), brokerEntryMetadataSize)) {
LOG_ERROR(cnxString_ << "[consumer id " << incomingCmd.message().consumer_id()
<< ", message ledger id "
<< incomingCmd.message().message_id().ledgerid() << ", entry id "
<< incomingCmd.message().message_id().entryid()
<< "] Error parsing broker entry metadata");
close(ResultDisconnected);
return;
}
incomingBuffer_.setReaderIndex(readerIndex + 2 + 4 + brokerEntryMetadataSize);
remainingBytes -= (2 + 4 + brokerEntryMetadataSize);
} else {
incomingBuffer_.setReaderIndex(readerIndex);
}
bool isChecksumValid = verifyChecksum(incomingBuffer_, remainingBytes, incomingCmd);
uint32_t metadataSize = incomingBuffer_.readUnsignedInt();
if (!msgMetadata.ParseFromArray(incomingBuffer_.data(), metadataSize)) {
LOG_ERROR(cnxString_ << "[consumer id " << incomingCmd.message().consumer_id() //
<< ", message ledger id "
<< incomingCmd.message().message_id().ledgerid() //
<< ", entry id " << incomingCmd.message().message_id().entryid()
<< "] Error parsing message metadata");
close(ResultDisconnected);
return;
}
incomingBuffer_.consume(metadataSize);
remainingBytes -= (4 + metadataSize);
uint32_t payloadSize = remainingBytes;
SharedBuffer payload = SharedBuffer::copy(incomingBuffer_.data(), payloadSize);
incomingBuffer_.consume(payloadSize);
handleIncomingMessage(incomingCmd.message(), isChecksumValid, brokerEntryMetadata, msgMetadata,
payload);
} else {
handleIncomingCommand(incomingCmd);
}
}
if (incomingBuffer_.readableBytes() > 0) {
// We still have 1 to 3 bytes from the next frame
assert(incomingBuffer_.readableBytes() < sizeof(uint32_t));
// Restart with a new buffer and copy the few bytes at the beginning
incomingBuffer_ = SharedBuffer::copyFrom(incomingBuffer_, DefaultBufferSize);
// At least we need to read 4 bytes to have the complete frame size
uint32_t minReadSize = sizeof(uint32_t) - incomingBuffer_.readableBytes();
auto self = shared_from_this();
asyncReceive(incomingBuffer_.asio_buffer(),
customAllocReadHandler([this, self, minReadSize](const boost::system::error_code& err,
size_t bytesTransferred) {
handleRead(err, bytesTransferred, minReadSize);
}));
return;
}
// We have read everything we had in the buffer
// Rollback the indexes to reuse the same buffer
incomingBuffer_.reset();
readNextCommand();
}
bool ClientConnection::verifyChecksum(SharedBuffer& incomingBuffer_, uint32_t& remainingBytes,
proto::BaseCommand& incomingCmd) {
int readerIndex = incomingBuffer_.readerIndex();
bool isChecksumValid = true;
if (incomingBuffer_.readUnsignedShort() == Commands::magicCrc32c) {
uint32_t storedChecksum = incomingBuffer_.readUnsignedInt();
remainingBytes -= (2 + 4) /* subtract size of checksum itself */;
// compute metadata-payload checksum
int metadataPayloadSize = remainingBytes;
uint32_t computedChecksum = computeChecksum(0, incomingBuffer_.data(), metadataPayloadSize);
// verify checksum
isChecksumValid = (storedChecksum == computedChecksum);
if (!isChecksumValid) {
LOG_ERROR("[consumer id "
<< incomingCmd.message().consumer_id() //
<< ", message ledger id " << incomingCmd.message().message_id().ledgerid() //
<< ", entry id " << incomingCmd.message().message_id().entryid() //
<< "stored-checksum" << storedChecksum << "computedChecksum" << computedChecksum //
<< "] Checksum verification failed");
}
} else {
incomingBuffer_.setReaderIndex(readerIndex);
}
return isChecksumValid;
}
void ClientConnection::handleActiveConsumerChange(const proto::CommandActiveConsumerChange& change) {
LOG_DEBUG(cnxString_ << "Received notification about active consumer change, consumer_id: "
<< change.consumer_id() << " isActive: " << change.is_active());
Lock lock(mutex_);
ConsumersMap::iterator it = consumers_.find(change.consumer_id());
if (it != consumers_.end()) {
ConsumerImplPtr consumer = it->second.lock();
if (consumer) {
lock.unlock();
consumer->activeConsumerChanged(change.is_active());
} else {
consumers_.erase(change.consumer_id());
LOG_DEBUG(cnxString_ << "Ignoring incoming message for already destroyed consumer "
<< change.consumer_id());
}
} else {
LOG_DEBUG(cnxString_ << "Got invalid consumer Id in " << change.consumer_id()
<< " -- isActive: " << change.is_active());
}
}
void ClientConnection::handleIncomingMessage(const proto::CommandMessage& msg, bool isChecksumValid,
proto::BrokerEntryMetadata& brokerEntryMetadata,
proto::MessageMetadata& msgMetadata, SharedBuffer& payload) {
LOG_DEBUG(cnxString_ << "Received a message from the server for consumer: " << msg.consumer_id());
Lock lock(mutex_);
ConsumersMap::iterator it = consumers_.find(msg.consumer_id());
if (it != consumers_.end()) {
ConsumerImplPtr consumer = it->second.lock();
if (consumer) {
// Unlock the mutex before notifying the consumer of the
// new received message
lock.unlock();
consumer->messageReceived(shared_from_this(), msg, isChecksumValid, brokerEntryMetadata,
msgMetadata, payload);
} else {
consumers_.erase(msg.consumer_id());
LOG_DEBUG(cnxString_ << "Ignoring incoming message for already destroyed consumer "
<< msg.consumer_id());
}
} else {
LOG_DEBUG(cnxString_ << "Got invalid consumer Id in " //
<< msg.consumer_id() << " -- msg: " << msgMetadata.sequence_id());
}
}
void ClientConnection::handleIncomingCommand(BaseCommand& incomingCmd) {
LOG_DEBUG(cnxString_ << "Handling incoming command: " << Commands::messageType(incomingCmd.type()));
switch (state_.load()) {
case Pending: {
LOG_ERROR(cnxString_ << "Connection is not ready yet");
break;
}
case TcpConnected: {
// Handle Pulsar Connected
if (incomingCmd.type() != BaseCommand::CONNECTED) {
// Wrong cmd
close();
} else {
handlePulsarConnected(incomingCmd.connected());
}
break;
}
case Disconnected: {
LOG_ERROR(cnxString_ << "Connection already disconnected");
break;
}
case Ready: {
// Since we are receiving data from the connection, we are assuming that for now the
// connection is still working well.
havePendingPingRequest_ = false;
// Handle normal commands
switch (incomingCmd.type()) {
case BaseCommand::SEND_RECEIPT:
handleSendReceipt(incomingCmd.send_receipt());
break;
case BaseCommand::SEND_ERROR:
handleSendError(incomingCmd.send_error());
break;
case BaseCommand::SUCCESS:
handleSuccess(incomingCmd.success());
break;
case BaseCommand::PARTITIONED_METADATA_RESPONSE:
handlePartitionedMetadataResponse(incomingCmd.partitionmetadataresponse());
break;
case BaseCommand::CONSUMER_STATS_RESPONSE:
handleConsumerStatsResponse(incomingCmd.consumerstatsresponse());
break;
case BaseCommand::LOOKUP_RESPONSE:
handleLookupTopicRespose(incomingCmd.lookuptopicresponse());
break;
case BaseCommand::PRODUCER_SUCCESS:
handleProducerSuccess(incomingCmd.producer_success());
break;
case BaseCommand::ERROR:
handleError(incomingCmd.error());
break;
case BaseCommand::CLOSE_PRODUCER:
handleCloseProducer(incomingCmd.close_producer());
break;
case BaseCommand::CLOSE_CONSUMER:
handleCloseConsumer(incomingCmd.close_consumer());
break;
case BaseCommand::PING:
// Respond to ping request
LOG_DEBUG(cnxString_ << "Replying to ping command");
sendCommand(Commands::newPong());
break;
case BaseCommand::PONG:
LOG_DEBUG(cnxString_ << "Received response to ping message");
break;
case BaseCommand::AUTH_CHALLENGE:
handleAuthChallenge();
break;
case BaseCommand::ACTIVE_CONSUMER_CHANGE:
handleActiveConsumerChange(incomingCmd.active_consumer_change());
break;
case BaseCommand::GET_LAST_MESSAGE_ID_RESPONSE:
handleGetLastMessageIdResponse(incomingCmd.getlastmessageidresponse());
break;
case BaseCommand::GET_TOPICS_OF_NAMESPACE_RESPONSE:
handleGetTopicOfNamespaceResponse(incomingCmd.gettopicsofnamespaceresponse());
break;
case BaseCommand::GET_SCHEMA_RESPONSE:
handleGetSchemaResponse(incomingCmd.getschemaresponse());
break;
case BaseCommand::ACK_RESPONSE:
handleAckResponse(incomingCmd.ackresponse());
break;
default:
LOG_WARN(cnxString_ << "Received invalid message from server");
close(ResultDisconnected);
break;
}
}
}
}