File: Subscription.i

package info (click to toggle)
robotraconteur 1.2.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 101,380 kB
  • sloc: cpp: 1,149,268; cs: 87,653; java: 58,127; python: 26,897; ansic: 356; sh: 152; makefile: 90; xml: 51
file content (437 lines) | stat: -rw-r--r-- 18,010 bytes parent folder | download
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
// Copyright 2011-2020 Wason Technology, LLC
//
// Licensed 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.

//Subscriptions

%shared_ptr(RobotRaconteur::WrappedServiceSubscriptionFilterNode);
%shared_ptr(RobotRaconteur::WrappedServiceSubscriptionFilter);
%shared_ptr(RobotRaconteur::WrappedServiceInfo2Subscription);
%shared_ptr(RobotRaconteur::WrappedServiceSubscription);
%shared_ptr(RobotRaconteur::WrappedPipeSubscription);
%shared_ptr(RobotRaconteur::WrappedWireSubscription);
%shared_ptr(RobotRaconteur::WrappedSubObjectSubscription);
%shared_ptr(RobotRaconteur::WrappedServiceSubscriptionManager)

%rename (WrappedServiceSubscriptionClientID) ServiceSubscriptionClientID;

%template(map_subscriptionserviceinfo2) std::map<RobotRaconteur::ServiceSubscriptionClientID, RobotRaconteur::ServiceInfo2Wrapped>;
%template(map_subscriptionclients) std::map<RobotRaconteur::ServiceSubscriptionClientID, boost::shared_ptr<RobotRaconteur::WrappedServiceStub> >;
%template(vectorptr_wrappedservicesubscriptionnode) std::vector<boost::shared_ptr<RobotRaconteur::WrappedServiceSubscriptionFilterNode> >;
%template(vectorptr_subscriptionclientid) std::vector<RobotRaconteur::ServiceSubscriptionClientID>;
%template(vector_wrappedservicesubscriptionmanagerdetails) std::vector<RobotRaconteur::WrappedServiceSubscriptionManagerDetails>;

%feature("director") RobotRaconteur::WrappedServiceInfo2SubscriptionDirector;
%feature("director") RobotRaconteur::WrappedServiceSubscriptionDirector;
%feature("director") RobotRaconteur::WrappedServiceSubscriptionFilterPredicateDirector;
%feature("director") RobotRaconteur::WrappedWireSubscriptionDirector;
%feature("director") RobotRaconteur::WrappedPipeSubscriptionDirector;



namespace RobotRaconteur
{

	class TimeSpec;
	class ServiceInfo2;

	class ServiceSubscriptionFilterAttribute
	{
		public:

			std::string Name;
			std::string Value;
			// boost::regex ValueRegex;
			bool UseRegex;

			ServiceSubscriptionFilterAttribute(const std::string& value);
			ServiceSubscriptionFilterAttribute(const std::string& name, const std::string& value);

			bool IsMatch(const std::string& value) const;
			bool IsMatch(const std::string& name, const std::string& value) const;
			bool IsMatch(const std::vector<std::string>& values) const;
			bool IsMatch(const std::map<std::string, std::string>& values) const;
	};

	ServiceSubscriptionFilterAttribute CreateServiceSubscriptionFilterAttributeRegex(const std::string& regex_value);
	ServiceSubscriptionFilterAttribute CreateServiceSubscriptionFilterAttributeRegex(const std::string& name, const std::string& regex_value);

	ServiceSubscriptionFilterAttribute
	CreateServiceSubscriptionFilterAttributeIdentifier(const std::string& identifier_name, const std::string& uuid_string);
	ServiceSubscriptionFilterAttribute
	CreateServiceSubscriptionFilterAttributeIdentifier(const std::string& name, const std::string& identifier_name, const std::string& uuid_string);
	ServiceSubscriptionFilterAttribute
	CreateServiceSubscriptionFilterAttributeCombinedIdentifier(const std::string& combined_identifier);
}

%template(vector_subscriptionattribute)  std::vector<RobotRaconteur::ServiceSubscriptionFilterAttribute>;
%template(map_subscriptionattribute)  std::map<std::string,RobotRaconteur::ServiceSubscriptionFilterAttribute>;

namespace RobotRaconteur
{

	enum ServiceSubscriptionFilterAttributeGroupOperation
	{
		ServiceSubscriptionFilterAttributeGroupOperation_OR,
		ServiceSubscriptionFilterAttributeGroupOperation_AND,
		ServiceSubscriptionFilterAttributeGroupOperation_NOR,
		ServiceSubscriptionFilterAttributeGroupOperation_NAND
	};


	class ServiceSubscriptionFilterAttributeGroup
	{
		public:
			std::vector<ServiceSubscriptionFilterAttribute> Attributes;
			std::vector<ServiceSubscriptionFilterAttributeGroup> Groups;
			ServiceSubscriptionFilterAttributeGroupOperation Operation;
			bool SplitStringAttribute;
        	char SplitStringDelimiter;

			ServiceSubscriptionFilterAttributeGroup();
			ServiceSubscriptionFilterAttributeGroup(ServiceSubscriptionFilterAttributeGroupOperation operation);
			ServiceSubscriptionFilterAttributeGroup(ServiceSubscriptionFilterAttributeGroupOperation operation, std::vector<ServiceSubscriptionFilterAttribute> attributes);
			ServiceSubscriptionFilterAttributeGroup(ServiceSubscriptionFilterAttributeGroupOperation operation, std::vector<ServiceSubscriptionFilterAttributeGroup> groups);

			bool IsMatch(const std::string& value) const;
			bool IsMatch(const std::vector<std::string>& values) const;
			bool IsMatch(const std::map<std::string, std::string>& values) const;
	};
}

%template(map_subscriptionattributegroup)  std::map<std::string,RobotRaconteur::ServiceSubscriptionFilterAttributeGroup>;

namespace RobotRaconteur
{

	class WrappedServiceSubscriptionFilterPredicateDirector
	{
	public:
		virtual bool Predicate(const ServiceInfo2Wrapped& info) = 0;

		virtual ~WrappedServiceSubscriptionFilterPredicateDirector() {}
	};

	class WrappedServiceSubscriptionFilterNode
	{
	public:
		::RobotRaconteur::NodeID NodeID;
		std::string NodeName;
		std::string Username;
		boost::intrusive_ptr<MessageElementData> Credentials;
	};

	class WrappedServiceSubscriptionFilter
	{
	public:
		std::vector<boost::shared_ptr<WrappedServiceSubscriptionFilterNode> > Nodes;
		std::vector<std::string> ServiceNames;
		std::vector<std::string> TransportSchemes;
		//boost::shared_ptr<WrappedServiceSubscriptionFilterPredicateDirector> Predicate;
		std::map<std::string,ServiceSubscriptionFilterAttributeGroup> Attributes;
		ServiceSubscriptionFilterAttributeGroupOperation AttributesMatchOperation;
		void SetRRPredicateDirector(WrappedServiceSubscriptionFilterPredicateDirector* director, int32_t id);
		uint32_t MaxConnections;
	};

	%nodefaultctor ServiceSubscriptionClientID;
	class ServiceSubscriptionClientID
	{
	public:

		%rename(eq) operator== ;
		%rename(ne) operator!=;

		::RobotRaconteur::NodeID NodeID;
		std::string ServiceName;

		bool operator == (const ServiceSubscriptionClientID &id2) const;

		bool operator != (const ServiceSubscriptionClientID &id2) const;
	};

	class WrappedServiceInfo2SubscriptionDirector
	{
	public:
		virtual void ServiceDetected(const boost::shared_ptr<RobotRaconteur::WrappedServiceInfo2Subscription>& subscription, const ServiceSubscriptionClientID& id, const ServiceInfo2Wrapped& service) = 0;
		virtual void ServiceLost(const boost::shared_ptr<RobotRaconteur::WrappedServiceInfo2Subscription>& subscription, const ServiceSubscriptionClientID& id, const ServiceInfo2Wrapped& service)  = 0;

		virtual ~WrappedServiceInfo2SubscriptionDirector() {}
	};

	%nodefaultctor WrappedServiceInfo2Subscription;
	class WrappedServiceInfo2Subscription
	{
	public:

		std::map<ServiceSubscriptionClientID, ServiceInfo2Wrapped> GetDetectedServiceInfo2();

		void Close();

		void SetRRDirector(WrappedServiceInfo2SubscriptionDirector* director, int32_t id);

		boost::shared_ptr<RobotRaconteur::RobotRaconteurNode> GetNode();

	};

	class WrappedServiceSubscriptionDirector
	{
	public:
		virtual void ClientConnected(const boost::shared_ptr<RobotRaconteur::WrappedServiceSubscription>& subscription, const ServiceSubscriptionClientID& id, const boost::shared_ptr<RobotRaconteur::WrappedServiceStub>& silent) = 0;
		virtual void ClientDisconnected(const boost::shared_ptr<RobotRaconteur::WrappedServiceSubscription>& subscription, const ServiceSubscriptionClientID& id, const boost::shared_ptr<RobotRaconteur::WrappedServiceStub>& silent) = 0;
		virtual void ClientConnectFailed(const boost::shared_ptr<RobotRaconteur::WrappedServiceSubscription>& subscription, const ServiceSubscriptionClientID& id, const std::vector<std::string>& url, HandlerErrorInfo& error) = 0;

		virtual ~WrappedServiceSubscriptionDirector() {}
	};

	class WrappedServiceSubscription_TryDefaultClientRes
	{
	public:
		bool res;
		boost::shared_ptr<RobotRaconteur::WrappedServiceStub> client;
	};

	class WrappedWireSubscription;
	class WrappedPipeSubscription;

	%nodefaultctor WrappedServiceSubscription;
	class WrappedServiceSubscription
	{
	public:

		std::map<ServiceSubscriptionClientID, boost::shared_ptr<WrappedServiceStub> > GetConnectedClients();

		void Close();

		void ClaimClient(const boost::shared_ptr<WrappedServiceStub>& client);
		void ReleaseClient(const boost::shared_ptr<WrappedServiceStub>& client);

		uint32_t GetConnectRetryDelay();
		void SetConnectRetryDelay(uint32_t delay_milliseconds);

		boost::shared_ptr<WrappedWireSubscription> SubscribeWire(const std::string& membername, const std::string& servicepath);

		boost::shared_ptr<WrappedPipeSubscription> SubscribePipe(const std::string& membername, const std::string& servicepath, int32_t max_recv_packets = -1);

		boost::shared_ptr<WrappedServiceStub> GetDefaultClient();

		WrappedServiceSubscription_TryDefaultClientRes TryGetDefaultClient();

		boost::shared_ptr<WrappedServiceStub> GetDefaultClientWait(int32_t timeout = -1);

		WrappedServiceSubscription_TryDefaultClientRes TryGetDefaultClientWait(int32_t timeout = -1);

		void AsyncGetDefaultClient(int32_t timeout, AsyncStubReturnDirector* handler, int32_t id);

		void SetRRDirector(WrappedServiceSubscriptionDirector* director, int32_t id);

		boost::shared_ptr<RobotRaconteur::RobotRaconteurNode> GetNode();

		std::vector<std::string> GetServiceURL();

		void UpdateServiceURL(const std::vector<std::string>& url, const std::string& username = "", boost::intrusive_ptr<MessageElementData> credentials=boost::intrusive_ptr<MessageElementData>(),  const std::string& objecttype = "", bool close_connected = false);
		void UpdateServiceURL(const std::string& url, const std::string& username = "", boost::intrusive_ptr<MessageElementData> credentials=boost::intrusive_ptr<MessageElementData>(),  const std::string& objecttype = "", bool close_connected = false);
		void UpdateServiceByType(const std::vector<std::string>& service_types, const boost::shared_ptr<WrappedServiceSubscriptionFilter>& filter = boost::shared_ptr<WrappedServiceSubscriptionFilter>());

		boost::shared_ptr<RobotRaconteur::WrappedSubObjectSubscription> SubscribeSubObject(const std::string& service_path, const std::string& objecttype="");

	};

	class WrappedWireSubscriptionDirector
	{
	public:
		virtual void WireValueChanged(const boost::shared_ptr<RobotRaconteur::WrappedWireSubscription>& wire_subscription, WrappedService_typed_packet& value, const TimeSpec& time) = 0;

		virtual ~WrappedWireSubscriptionDirector() {}
	};


	%nodefaultctor WrappedWireSubscription;
	class WrappedWireSubscription
	{
	public:

		WrappedService_typed_packet GetInValue(TimeSpec* time = NULL);
		bool TryGetInValue(WrappedService_typed_packet& val, TimeSpec* time = NULL);

		bool WaitInValueValid(int32_t timeout = RR_TIMEOUT_INFINITE);

		bool GetIgnoreInValue();
		void SetIgnoreInValue(bool ignore);

		int32_t GetInValueLifespan();
		void SetInValueLifespan(int32_t millis);

		size_t GetActiveWireConnectionCount();

		void Close();

		void SetRRDirector(WrappedWireSubscriptionDirector* director, int32_t id);

		boost::shared_ptr<RobotRaconteur::RobotRaconteurNode> GetNode();

	};

	class WrappedWireSubscription_send_iterator
	{
	public:
		WrappedWireSubscription_send_iterator(const boost::shared_ptr<WrappedWireSubscription>& sub);
		boost::shared_ptr<WrappedWireConnection> Next();
		void SetOutValue(const boost::intrusive_ptr<MessageElement>& value);
		boost::shared_ptr<TypeDefinition> GetType();
		boost::shared_ptr<WrappedServiceStub> GetStub();
		virtual ~WrappedWireSubscription_send_iterator();
	};

	class WrappedPipeSubscriptionDirector
	{
	public:
		virtual void PipePacketReceived(const boost::shared_ptr<RobotRaconteur::WrappedPipeSubscription>& pipe_subscription) = 0;

		virtual ~WrappedPipeSubscriptionDirector() {}
	};

	%nodefaultctor WrappedPipeSubscription;
	class WrappedPipeSubscription
	{
	public:

		WrappedService_typed_packet ReceivePacket();
		bool TryReceivePacket(WrappedService_typed_packet& packet);
		bool TryReceivePacketWait(WrappedService_typed_packet& packet, int32_t timeout = RR_TIMEOUT_INFINITE, bool peek = false);

		size_t Available();
		size_t GetActivePipeEndpointCount();

		bool GetIgnoreReceived();
		void SetIgnoreReceived(bool ignore);

		void Close();

		void SetRRDirector(WrappedPipeSubscriptionDirector* director, int32_t id);

		boost::shared_ptr<RobotRaconteur::RobotRaconteurNode> GetNode();
	};

	class WrappedPipeSubscription_send_iterator
	{
	public:
		WrappedPipeSubscription_send_iterator(const boost::shared_ptr<WrappedPipeSubscription>& sub);
		boost::shared_ptr<WrappedPipeEndpoint> Next();
		void AsyncSendPacket(const boost::intrusive_ptr<MessageElement>& value);
		boost::shared_ptr<TypeDefinition> GetType();
		boost::shared_ptr<WrappedServiceStub> GetStub();
		virtual ~WrappedPipeSubscription_send_iterator();
	};

	%nodefaultctor WrappedSubObjectSubscription;
	class WrappedSubObjectSubscription
	{
	public:

		boost::shared_ptr<RobotRaconteur::WrappedServiceStub> GetDefaultClient();

		WrappedServiceSubscription_TryDefaultClientRes TryGetDefaultClient();

		boost::shared_ptr<RobotRaconteur::WrappedServiceStub> GetDefaultClientWait(int32_t timeout = -1);

		WrappedServiceSubscription_TryDefaultClientRes TryGetDefaultClientWait(int32_t timeout = -1);

		void AsyncGetDefaultClient(int32_t timeout, AsyncStubReturnDirector* handler, int32_t id);

		void Close();

		boost::shared_ptr<RobotRaconteur::RobotRaconteurNode> GetNode();
	};

	std::vector<ServiceSubscriptionClientID> WrappedServiceInfo2SubscriptionServicesToVector(std::map<ServiceSubscriptionClientID, ServiceInfo2Wrapped >& infos);

	boost::shared_ptr<WrappedServiceInfo2Subscription> WrappedSubscribeServiceInfo2(const boost::shared_ptr<RobotRaconteurNode>& node, const std::vector<std::string>& service_types, boost::shared_ptr<WrappedServiceSubscriptionFilter> filter = boost::shared_ptr<WrappedServiceSubscriptionFilter>());

	std::vector<ServiceSubscriptionClientID> WrappedServiceSubscriptionClientsToVector(std::map<ServiceSubscriptionClientID, boost::shared_ptr<WrappedServiceStub> >& clients);

	boost::shared_ptr<WrappedServiceSubscription> WrappedSubscribeServiceByType(const boost::shared_ptr<RobotRaconteurNode>& node, const std::vector<std::string>& service_types, boost::shared_ptr<WrappedServiceSubscriptionFilter> filter = boost::shared_ptr<WrappedServiceSubscriptionFilter>());

	boost::shared_ptr<WrappedServiceSubscription> WrappedSubscribeService(const boost::shared_ptr<RobotRaconteurNode>& node, const std::vector<std::string>& url, const std::string& username = "", boost::intrusive_ptr<MessageElementData> credentials=boost::intrusive_ptr<MessageElementData>(),  const std::string& objecttype = "");

	boost::shared_ptr<WrappedServiceSubscription> WrappedSubscribeService(const boost::shared_ptr<RobotRaconteurNode>& node, const std::string& url, const std::string& username = "", boost::intrusive_ptr<MessageElementData> credentials=boost::intrusive_ptr<MessageElementData>(),  const std::string& objecttype = "");

	enum ServiceSubscriptionManager_CONNECTION_METHOD
	{
		ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT,
		ServiceSubscriptionManager_CONNECTION_METHOD_URL,
		ServiceSubscriptionManager_CONNECTION_METHOD_TYPE
	};

	struct WrappedServiceSubscriptionManagerDetails
	{
		std::string Name;
		ServiceSubscriptionManager_CONNECTION_METHOD ConnectionMethod;
		std::vector<std::string> Urls;
		std::string UrlUsername;
		boost::intrusive_ptr<MessageElementData> UrlCredentials;
		std::vector<std::string> ServiceTypes;
		boost::shared_ptr<WrappedServiceSubscriptionFilter> Filter;
		bool Enabled;

		WrappedServiceSubscriptionManagerDetails();

		WrappedServiceSubscriptionManagerDetails(
			const std::string& Name = "",
			ServiceSubscriptionManager_CONNECTION_METHOD Connection_method =
				ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT,
			const std::vector<std::string>& Urls = std::vector<std::string>(), const std::string& UrlUsername = "",
			const boost::intrusive_ptr<MessageElementData>& UrlCredentials =
				boost::intrusive_ptr<MessageElementData>(),
			const std::vector<std::string>& ServiceTypes = std::vector<std::string>(),
			const boost::shared_ptr<WrappedServiceSubscriptionFilter>& Filter = boost::shared_ptr<WrappedServiceSubscriptionFilter>(),
			bool Enabled = false);
	};

	class WrappedServiceSubscriptionManager
	{
	public:

		WrappedServiceSubscriptionManager();

		WrappedServiceSubscriptionManager(const boost::shared_ptr<RobotRaconteurNode>& node);

		WrappedServiceSubscriptionManager(const std::vector<WrappedServiceSubscriptionManagerDetails>& details);

		WrappedServiceSubscriptionManager(const std::vector<WrappedServiceSubscriptionManagerDetails>& details,
								const boost::shared_ptr<RobotRaconteurNode>& node);

		void AddSubscription(const WrappedServiceSubscriptionManagerDetails& details);

		void RemoveSubscription(const std::string& name, bool close = true);

		void EnableSubscription(const std::string& name);

		void DisableSubscription(const std::string& name, bool close = true);

		boost::shared_ptr<WrappedServiceSubscription> GetSubscription(const std::string& name, bool force_create = true);

		bool IsConnected(const std::string& name);

		bool IsEnabled(const std::string& name);

		void Close(bool close_subscriptions = true);

		std::vector<std::string> GetSubscriptionNames();

    	std::vector<WrappedServiceSubscriptionManagerDetails> GetSubscriptionDetails();

		boost::shared_ptr<RobotRaconteurNode> GetNode();
	};

}