forked from robocomp/dsr-graph
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Connection.h
1658 lines (1459 loc) · 51.5 KB
/
Connection.h
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
//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.3
//
// <auto-generated>
//
// Generated from file `Connection.ice'
//
// Warning: do not edit this file.
//
// </auto-generated>
//
#ifndef __Ice_Connection_h__
#define __Ice_Connection_h__
#include <IceUtil/PushDisableWarnings.h>
#include <Ice/ProxyF.h>
#include <Ice/ObjectF.h>
#include <Ice/ValueF.h>
#include <Ice/Exception.h>
#include <Ice/LocalObject.h>
#include <Ice/StreamHelpers.h>
#include <Ice/Comparable.h>
#include <Ice/OutgoingAsync.h>
#include <IceUtil/ScopedArray.h>
#include <Ice/Optional.h>
#include <Ice/ObjectAdapterF.h>
#include <Ice/Identity.h>
#include <Ice/Endpoint.h>
#include <IceUtil/UndefSysMacros.h>
#ifndef ICE_IGNORE_VERSION
# if ICE_INT_VERSION / 100 != 307
# error Ice version mismatch!
# endif
# if ICE_INT_VERSION % 100 >= 50
# error Beta header file detected
# endif
# if ICE_INT_VERSION % 100 < 3
# error Ice patch level mismatch!
# endif
#endif
#ifndef ICE_API
# if defined(ICE_STATIC_LIBS)
# define ICE_API /**/
# elif defined(ICE_API_EXPORTS)
# define ICE_API ICE_DECLSPEC_EXPORT
# else
# define ICE_API ICE_DECLSPEC_IMPORT
# endif
#endif
#ifdef ICE_CPP11_MAPPING // C++11 mapping
namespace Ice
{
class ConnectionInfo;
class Connection;
class IPConnectionInfo;
class TCPConnectionInfo;
class UDPConnectionInfo;
class WSConnectionInfo;
}
namespace Ice
{
/**
* The batch compression option when flushing queued batch requests.
*/
enum class CompressBatch : unsigned char
{
/**
* Compress the batch requests.
*/
Yes,
/**
* Don't compress the batch requests.
*/
No,
/**
* Compress the batch requests if at least one request was
* made on a compressed proxy.
*/
BasedOnProxy
};
/**
* Specifies the close semantics for Active Connection Management.
*/
enum class ACMClose : unsigned char
{
/**
* Disables automatic connection closure.
*/
CloseOff,
/**
* Gracefully closes a connection that has been idle for the configured timeout period.
*/
CloseOnIdle,
/**
* Forcefully closes a connection that has been idle for the configured timeout period,
* but only if the connection has pending invocations.
*/
CloseOnInvocation,
/**
* Combines the behaviors of CloseOnIdle and CloseOnInvocation.
*/
CloseOnInvocationAndIdle,
/**
* Forcefully closes a connection that has been idle for the configured timeout period,
* regardless of whether the connection has pending invocations or dispatch.
*/
CloseOnIdleForceful
};
/**
* Specifies the heartbeat semantics for Active Connection Management.
*/
enum class ACMHeartbeat : unsigned char
{
/**
* Disables heartbeats.
*/
HeartbeatOff,
/**
* Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.
*/
HeartbeatOnDispatch,
/**
* Send a heartbeat at regular intervals when the connection is idle.
*/
HeartbeatOnIdle,
/**
* Send a heartbeat at regular intervals until the connection is closed.
*/
HeartbeatAlways
};
/**
* A collection of Active Connection Management configuration settings.
* \headerfile Ice/Ice.h
*/
struct ACM
{
/**
* A timeout value in seconds.
*/
int timeout;
/**
* The close semantics.
*/
::Ice::ACMClose close;
/**
* The heartbeat semantics.
*/
::Ice::ACMHeartbeat heartbeat;
/**
* Obtains a tuple containing all of the struct's data members.
* @return The data members in a tuple.
*/
std::tuple<const int&, const ::Ice::ACMClose&, const ::Ice::ACMHeartbeat&> ice_tuple() const
{
return std::tie(timeout, close, heartbeat);
}
};
/**
* Determines the behavior when manually closing a connection.
*/
enum class ConnectionClose : unsigned char
{
/**
* Close the connection immediately without sending a close connection protocol message to the peer
* and waiting for the peer to acknowledge it.
*/
Forcefully,
/**
* Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
* On the server side, the connection will not be closed until all incoming invocations have completed.
*/
Gracefully,
/**
* Wait for all pending invocations to complete before closing the connection.
*/
GracefullyWithWait
};
/**
* A collection of HTTP headers.
*/
using HeaderDict = ::std::map<::std::string, ::std::string>;
using Ice::operator<;
using Ice::operator<=;
using Ice::operator>;
using Ice::operator>=;
using Ice::operator==;
using Ice::operator!=;
}
namespace Ice
{
/**
* Base class providing access to the connection details.
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) ConnectionInfo
{
public:
ICE_MEMBER(ICE_API) virtual ~ConnectionInfo();
ConnectionInfo() = default;
ConnectionInfo(const ConnectionInfo&) = default;
ConnectionInfo(ConnectionInfo&&) = default;
ConnectionInfo& operator=(const ConnectionInfo&) = default;
ConnectionInfo& operator=(ConnectionInfo&&) = default;
/**
* One-shot constructor to initialize all data members.
* @param underlying The information of the underyling transport or null if there's no underlying transport.
* @param incoming Whether or not the connection is an incoming or outgoing connection.
* @param adapterName The name of the adapter associated with the connection.
* @param connectionId The connection id.
*/
ConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId) :
underlying(::std::move(underlying)),
incoming(incoming),
adapterName(::std::move(adapterName)),
connectionId(::std::move(connectionId))
{
}
/**
* The information of the underyling transport or null if there's
* no underlying transport.
*/
::std::shared_ptr<::Ice::ConnectionInfo> underlying;
/**
* Whether or not the connection is an incoming or outgoing
* connection.
*/
bool incoming;
/**
* The name of the adapter associated with the connection.
*/
::std::string adapterName;
/**
* The connection id.
*/
::std::string connectionId;
};
/**
* This method is called by the the connection when the connection
* is closed. If the callback needs more information about the closure,
* it can call {@link Connection#throwException}.
* @param con The connection that closed.
*/
using CloseCallback = ::std::function<void(const ::std::shared_ptr<Connection>& con)>;
/**
* This method is called by the the connection when a heartbeat is
* received from the peer.
* @param con The connection on which a heartbeat was received.
*/
using HeartbeatCallback = ::std::function<void(const ::std::shared_ptr<Connection>& con)>;
/**
* The user-level interface to a connection.
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) Connection
{
public:
ICE_MEMBER(ICE_API) virtual ~Connection();
/**
* Manually close the connection using the specified closure mode.
* @param mode Determines how the connection will be closed.
* @see ConnectionClose
*/
virtual void close(ConnectionClose mode) noexcept = 0;
/**
* Create a special proxy that always uses this connection. This
* can be used for callbacks from a server to a client if the
* server cannot directly establish a connection to the client,
* for example because of firewalls. In this case, the server
* would create a proxy using an already established connection
* from the client.
* @param id The identity for which a proxy is to be created.
* @return A proxy that matches the given identity and uses this
* connection.
* @see #setAdapter
*/
virtual ::std::shared_ptr<::Ice::ObjectPrx> createProxy(const Identity& id) const = 0;
/**
* Explicitly set an object adapter that dispatches requests that
* are received over this connection. A client can invoke an
* operation on a server using a proxy, and then set an object
* adapter for the outgoing connection that is used by the proxy
* in order to receive callbacks. This is useful if the server
* cannot establish a connection back to the client, for example
* because of firewalls.
* @param adapter The object adapter that should be used by this
* connection to dispatch requests. The object adapter must be
* activated. When the object adapter is deactivated, it is
* automatically removed from the connection. Attempts to use a
* deactivated object adapter raise {@link ObjectAdapterDeactivatedException}
* @see #createProxy
* @see #getAdapter
*/
virtual void setAdapter(const ::std::shared_ptr<ObjectAdapter>& adapter) = 0;
/**
* Get the object adapter that dispatches requests for this
* connection.
* @return The object adapter that dispatches requests for the
* connection, or null if no adapter is set.
* @see #setAdapter
*/
virtual ::std::shared_ptr<::Ice::ObjectAdapter> getAdapter() const noexcept = 0;
/**
* Get the endpoint from which the connection was created.
* @return The endpoint from which the connection was created.
*/
virtual ::std::shared_ptr<::Ice::Endpoint> getEndpoint() const noexcept = 0;
/**
* Flush any pending batch requests for this connection.
* This means all batch requests invoked on fixed proxies
* associated with the connection.
* @param compress Specifies whether or not the queued batch requests
* should be compressed before being sent over the wire.
*/
virtual void flushBatchRequests(CompressBatch compress)
{
flushBatchRequestsAsync(compress).get();
}
/**
* Flush any pending batch requests for this connection.
* This means all batch requests invoked on fixed proxies
* associated with the connection.
* @param compress Specifies whether or not the queued batch requests
* should be compressed before being sent over the wire.
* @param exception The exception callback.
* @param sent The sent callback.
* @return A function that can be called to cancel the invocation locally.
*/
virtual ::std::function<void()>
flushBatchRequestsAsync(CompressBatch compress,
::std::function<void(::std::exception_ptr)> exception,
::std::function<void(bool)> sent = nullptr) = 0;
/**
* Flush any pending batch requests for this connection.
* This means all batch requests invoked on fixed proxies
* associated with the connection.
* @param compress Specifies whether or not the queued batch requests
* should be compressed before being sent over the wire.
* @return The future object for the invocation.
*/
template<template<typename> class P = ::std::promise>
auto flushBatchRequestsAsync(CompressBatch compress)
-> decltype(::std::declval<P<void>>().get_future())
{
using Promise = P<void>;
auto promise = ::std::make_shared<Promise>();
flushBatchRequestsAsync(compress,
[promise](::std::exception_ptr ex)
{
promise->set_exception(::std::move(ex));
},
[promise](bool)
{
promise->set_value();
});
return promise->get_future();
}
/**
* Set a close callback on the connection. The callback is called by the
* connection when it's closed. The callback is called from the
* Ice thread pool associated with the connection. If the callback needs
* more information about the closure, it can call {@link Connection#throwException}.
* @param callback The close callback object.
*/
virtual void setCloseCallback(CloseCallback callback) = 0;
/**
* Set a heartbeat callback on the connection. The callback is called by the
* connection when a heartbeat is received. The callback is called
* from the Ice thread pool associated with the connection.
* @param callback The heartbeat callback object.
*/
virtual void setHeartbeatCallback(HeartbeatCallback callback) = 0;
/**
* Send a heartbeat message.
*/
virtual void heartbeat()
{
heartbeatAsync().get();
}
/**
* Send a heartbeat message.
* @param exception The exception callback.
* @param sent The sent callback.
* @return A function that can be called to cancel the invocation locally.
*/
virtual ::std::function<void()>
heartbeatAsync(::std::function<void(::std::exception_ptr)> exception,
::std::function<void(bool)> sent = nullptr) = 0;
/**
* Send a heartbeat message.
* @return The future object for the invocation.
*/
template<template<typename> class P = ::std::promise>
auto heartbeatAsync()
-> decltype(::std::declval<P<void>>().get_future())
{
using Promise = P<void>;
auto promise = ::std::make_shared<Promise>();
heartbeatAsync([promise](::std::exception_ptr ex)
{
promise->set_exception(::std::move(ex));
},
[promise](bool)
{
promise->set_value();
});
return promise->get_future();
}
/**
* Set the active connection management parameters.
* @param timeout The timeout value in seconds, must be >= 0.
* @param close The close condition
* @param heartbeat The hertbeat condition
*/
virtual void setACM(const Ice::optional<int>& timeout, const Ice::optional<ACMClose>& close, const Ice::optional<ACMHeartbeat>& heartbeat) = 0;
/**
* Get the ACM parameters.
* @return The ACM parameters.
*/
virtual ::Ice::ACM getACM() noexcept = 0;
/**
* Return the connection type. This corresponds to the endpoint
* type, i.e., "tcp", "udp", etc.
* @return The type of the connection.
*/
virtual ::std::string type() const noexcept = 0;
/**
* Get the timeout for the connection.
* @return The connection's timeout.
*/
virtual int timeout() const noexcept = 0;
/**
* Return a description of the connection as human readable text,
* suitable for logging or error messages.
* @return The description of the connection as human readable
* text.
*/
virtual ::std::string toString() const noexcept = 0;
/**
* Returns the connection information.
* @return The connection information.
*/
virtual ::std::shared_ptr<::Ice::ConnectionInfo> getInfo() const = 0;
/**
* Set the connection buffer receive/send size.
* @param rcvSize The connection receive buffer size.
* @param sndSize The connection send buffer size.
*/
virtual void setBufferSize(int rcvSize, int sndSize) = 0;
/**
* Throw an exception indicating the reason for connection closure. For example,
* {@link CloseConnectionException} is raised if the connection was closed gracefully,
* whereas {@link ConnectionManuallyClosedException} is raised if the connection was
* manually closed by the application. This operation does nothing if the connection is
* not yet closed.
*/
virtual void throwException() const = 0;
};
/**
* Provides access to the connection details of an IP connection
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) IPConnectionInfo : public ::Ice::ConnectionInfo
{
public:
ICE_MEMBER(ICE_API) virtual ~IPConnectionInfo();
IPConnectionInfo() :
localAddress(/*u8*/""),
localPort(-1),
remoteAddress(/*u8*/""),
remotePort(-1){};
IPConnectionInfo(const IPConnectionInfo&) = default;
IPConnectionInfo(IPConnectionInfo&&) = default;
IPConnectionInfo& operator=(const IPConnectionInfo&) = default;
IPConnectionInfo& operator=(IPConnectionInfo&&) = default;
/**
* One-shot constructor to initialize all data members.
* @param underlying The information of the underyling transport or null if there's no underlying transport.
* @param incoming Whether or not the connection is an incoming or outgoing connection.
* @param adapterName The name of the adapter associated with the connection.
* @param connectionId The connection id.
* @param localAddress The local address.
* @param localPort The local port.
* @param remoteAddress The remote address.
* @param remotePort The remote port.
*/
IPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort) :
ConnectionInfo(::std::move(underlying), incoming, ::std::move(adapterName), ::std::move(connectionId)),
localAddress(::std::move(localAddress)),
localPort(localPort),
remoteAddress(::std::move(remoteAddress)),
remotePort(remotePort)
{
}
/**
* The local address.
*/
::std::string localAddress;
/**
* The local port.
*/
int localPort = -1;
/**
* The remote address.
*/
::std::string remoteAddress;
/**
* The remote port.
*/
int remotePort = -1;
};
/**
* Provides access to the connection details of a TCP connection
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) TCPConnectionInfo : public ::Ice::IPConnectionInfo
{
public:
ICE_MEMBER(ICE_API) virtual ~TCPConnectionInfo();
TCPConnectionInfo() :
rcvSize(0),
sndSize(0)
{
}
TCPConnectionInfo(const TCPConnectionInfo&) = default;
TCPConnectionInfo(TCPConnectionInfo&&) = default;
TCPConnectionInfo& operator=(const TCPConnectionInfo&) = default;
TCPConnectionInfo& operator=(TCPConnectionInfo&&) = default;
/**
* One-shot constructor to initialize all data members.
* @param underlying The information of the underyling transport or null if there's no underlying transport.
* @param incoming Whether or not the connection is an incoming or outgoing connection.
* @param adapterName The name of the adapter associated with the connection.
* @param connectionId The connection id.
* @param localAddress The local address.
* @param localPort The local port.
* @param remoteAddress The remote address.
* @param remotePort The remote port.
* @param rcvSize The connection buffer receive size.
* @param sndSize The connection buffer send size.
*/
TCPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort, int rcvSize, int sndSize) :
IPConnectionInfo(::std::move(underlying), incoming, ::std::move(adapterName), ::std::move(connectionId), ::std::move(localAddress), localPort, ::std::move(remoteAddress), remotePort),
rcvSize(rcvSize),
sndSize(sndSize)
{
}
/**
* The connection buffer receive size.
*/
int rcvSize = 0;
/**
* The connection buffer send size.
*/
int sndSize = 0;
};
/**
* Provides access to the connection details of a UDP connection
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) UDPConnectionInfo : public ::Ice::IPConnectionInfo
{
public:
ICE_MEMBER(ICE_API) virtual ~UDPConnectionInfo();
UDPConnectionInfo() :
mcastPort(-1),
rcvSize(0),
sndSize(0)
{
}
UDPConnectionInfo(const UDPConnectionInfo&) = default;
UDPConnectionInfo(UDPConnectionInfo&&) = default;
UDPConnectionInfo& operator=(const UDPConnectionInfo&) = default;
UDPConnectionInfo& operator=(UDPConnectionInfo&&) = default;
/**
* One-shot constructor to initialize all data members.
* @param underlying The information of the underyling transport or null if there's no underlying transport.
* @param incoming Whether or not the connection is an incoming or outgoing connection.
* @param adapterName The name of the adapter associated with the connection.
* @param connectionId The connection id.
* @param localAddress The local address.
* @param localPort The local port.
* @param remoteAddress The remote address.
* @param remotePort The remote port.
* @param mcastAddress The multicast address.
* @param mcastPort The multicast port.
* @param rcvSize The connection buffer receive size.
* @param sndSize The connection buffer send size.
*/
UDPConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::std::string& localAddress, int localPort, const ::std::string& remoteAddress, int remotePort, const ::std::string& mcastAddress, int mcastPort, int rcvSize, int sndSize) :
IPConnectionInfo(::std::move(underlying), incoming, ::std::move(adapterName), ::std::move(connectionId), ::std::move(localAddress), localPort, ::std::move(remoteAddress), remotePort),
mcastAddress(::std::move(mcastAddress)),
mcastPort(mcastPort),
rcvSize(rcvSize),
sndSize(sndSize)
{
}
/**
* The multicast address.
*/
::std::string mcastAddress;
/**
* The multicast port.
*/
int mcastPort = -1;
/**
* The connection buffer receive size.
*/
int rcvSize = 0;
/**
* The connection buffer send size.
*/
int sndSize = 0;
};
/**
* Provides access to the connection details of a WebSocket connection
* \headerfile Ice/Ice.h
*/
class ICE_CLASS(ICE_API) WSConnectionInfo : public ::Ice::ConnectionInfo
{
public:
ICE_MEMBER(ICE_API) virtual ~WSConnectionInfo();
WSConnectionInfo() = default;
WSConnectionInfo(const WSConnectionInfo&) = default;
WSConnectionInfo(WSConnectionInfo&&) = default;
WSConnectionInfo& operator=(const WSConnectionInfo&) = default;
WSConnectionInfo& operator=(WSConnectionInfo&&) = default;
/**
* One-shot constructor to initialize all data members.
* @param underlying The information of the underyling transport or null if there's no underlying transport.
* @param incoming Whether or not the connection is an incoming or outgoing connection.
* @param adapterName The name of the adapter associated with the connection.
* @param connectionId The connection id.
* @param headers The headers from the HTTP upgrade request.
*/
WSConnectionInfo(const ::std::shared_ptr<::Ice::ConnectionInfo>& underlying, bool incoming, const ::std::string& adapterName, const ::std::string& connectionId, const ::Ice::HeaderDict& headers) :
ConnectionInfo(::std::move(underlying), incoming, ::std::move(adapterName), ::std::move(connectionId)),
headers(::std::move(headers))
{
}
/**
* The headers from the HTTP upgrade request.
*/
::Ice::HeaderDict headers;
};
}
/// \cond STREAM
namespace Ice
{
}
/// \endcond
/// \cond INTERNAL
namespace Ice
{
using ConnectionInfoPtr = ::std::shared_ptr<ConnectionInfo>;
using ConnectionPtr = ::std::shared_ptr<Connection>;
using IPConnectionInfoPtr = ::std::shared_ptr<IPConnectionInfo>;
using TCPConnectionInfoPtr = ::std::shared_ptr<TCPConnectionInfo>;
using UDPConnectionInfoPtr = ::std::shared_ptr<UDPConnectionInfo>;
using WSConnectionInfoPtr = ::std::shared_ptr<WSConnectionInfo>;
}
/// \endcond
#else // C++98 mapping
namespace Ice
{
class ConnectionInfo;
/// \cond INTERNAL
ICE_API LocalObject* upCast(ConnectionInfo*);
/// \endcond
typedef ::IceInternal::Handle< ConnectionInfo> ConnectionInfoPtr;
class Connection;
/// \cond INTERNAL
ICE_API LocalObject* upCast(Connection*);
/// \endcond
typedef ::IceInternal::Handle< Connection> ConnectionPtr;
class CloseCallback;
/// \cond INTERNAL
ICE_API LocalObject* upCast(CloseCallback*);
/// \endcond
typedef ::IceInternal::Handle< CloseCallback> CloseCallbackPtr;
class HeartbeatCallback;
/// \cond INTERNAL
ICE_API LocalObject* upCast(HeartbeatCallback*);
/// \endcond
typedef ::IceInternal::Handle< HeartbeatCallback> HeartbeatCallbackPtr;
class IPConnectionInfo;
/// \cond INTERNAL
ICE_API LocalObject* upCast(IPConnectionInfo*);
/// \endcond
typedef ::IceInternal::Handle< IPConnectionInfo> IPConnectionInfoPtr;
class TCPConnectionInfo;
/// \cond INTERNAL
ICE_API LocalObject* upCast(TCPConnectionInfo*);
/// \endcond
typedef ::IceInternal::Handle< TCPConnectionInfo> TCPConnectionInfoPtr;
class UDPConnectionInfo;
/// \cond INTERNAL
ICE_API LocalObject* upCast(UDPConnectionInfo*);
/// \endcond
typedef ::IceInternal::Handle< UDPConnectionInfo> UDPConnectionInfoPtr;
class WSConnectionInfo;
/// \cond INTERNAL
ICE_API LocalObject* upCast(WSConnectionInfo*);
/// \endcond
typedef ::IceInternal::Handle< WSConnectionInfo> WSConnectionInfoPtr;
}
namespace Ice
{
/**
* The batch compression option when flushing queued batch requests.
*/
enum CompressBatch
{
/**
* Compress the batch requests.
*/
CompressBatchYes,
/**
* Don't compress the batch requests.
*/
CompressBatchNo,
/**
* Compress the batch requests if at least one request was
* made on a compressed proxy.
*/
CompressBatchBasedOnProxy
};
/**
* Specifies the close semantics for Active Connection Management.
*/
enum ACMClose
{
/**
* Disables automatic connection closure.
*/
CloseOff,
/**
* Gracefully closes a connection that has been idle for the configured timeout period.
*/
CloseOnIdle,
/**
* Forcefully closes a connection that has been idle for the configured timeout period,
* but only if the connection has pending invocations.
*/
CloseOnInvocation,
/**
* Combines the behaviors of CloseOnIdle and CloseOnInvocation.
*/
CloseOnInvocationAndIdle,
/**
* Forcefully closes a connection that has been idle for the configured timeout period,
* regardless of whether the connection has pending invocations or dispatch.
*/
CloseOnIdleForceful
};
/**
* Specifies the heartbeat semantics for Active Connection Management.
*/
enum ACMHeartbeat
{
/**
* Disables heartbeats.
*/
HeartbeatOff,
/**
* Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.
*/
HeartbeatOnDispatch,
/**
* Send a heartbeat at regular intervals when the connection is idle.
*/
HeartbeatOnIdle,
/**
* Send a heartbeat at regular intervals until the connection is closed.
*/
HeartbeatAlways
};
/**
* A collection of Active Connection Management configuration settings.
* \headerfile Ice/Ice.h
*/
struct ACM
{
/**
* A timeout value in seconds.
*/
::Ice::Int timeout;
/**
* The close semantics.
*/
::Ice::ACMClose close;
/**
* The heartbeat semantics.
*/
::Ice::ACMHeartbeat heartbeat;
bool operator==(const ACM& rhs_) const
{
if(this == &rhs_)
{
return true;
}
if(timeout != rhs_.timeout)
{
return false;
}
if(close != rhs_.close)
{
return false;
}
if(heartbeat != rhs_.heartbeat)
{
return false;
}
return true;
}
bool operator<(const ACM& rhs_) const
{
if(this == &rhs_)
{
return false;
}
if(timeout < rhs_.timeout)
{
return true;
}
else if(rhs_.timeout < timeout)
{
return false;
}
if(close < rhs_.close)
{
return true;
}
else if(rhs_.close < close)
{
return false;
}
if(heartbeat < rhs_.heartbeat)
{
return true;
}
else if(rhs_.heartbeat < heartbeat)
{
return false;
}
return false;
}
bool operator!=(const ACM& rhs_) const
{
return !operator==(rhs_);
}
bool operator<=(const ACM& rhs_) const
{
return operator<(rhs_) || operator==(rhs_);
}
bool operator>(const ACM& rhs_) const
{
return !operator<(rhs_) && !operator==(rhs_);
}
bool operator>=(const ACM& rhs_) const
{
return !operator<(rhs_);
}
};
/**
* Determines the behavior when manually closing a connection.
*/
enum ConnectionClose
{
/**
* Close the connection immediately without sending a close connection protocol message to the peer
* and waiting for the peer to acknowledge it.
*/
ConnectionCloseForcefully,
/**
* Close the connection by notifying the peer but do not wait for pending outgoing invocations to complete.
* On the server side, the connection will not be closed until all incoming invocations have completed.
*/
ConnectionCloseGracefully,
/**
* Wait for all pending invocations to complete before closing the connection.
*/
ConnectionCloseGracefullyWithWait
};
/**
* A collection of HTTP headers.
*/
typedef ::std::map< ::std::string, ::std::string> HeaderDict;
}
namespace Ice
{