Application.h 14.2 KB
Newer Older
legoc's avatar
legoc committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/*
 * Copyright 2015 Institut Laue-Langevin
 *
 * Licensed under the EUPL, Version 1.1 only (the "License");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://joinup.ec.europa.eu/software/page/eupl
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 */

#ifndef CAMEO_APPLICATION_H_
#define CAMEO_APPLICATION_H_

legoc's avatar
legoc committed
20
#include <functional>
legoc's avatar
legoc committed
21
22
23
#include <vector>
#include <set>
#include <memory>
24
#include "InvalidArgumentException.h"
25
#include "UnmanagedApplicationException.h"
26
#include "SocketException.h"
27
28
29
30
31
#include "ConnectionTimeout.h"
#include "PublisherCreationException.h"
#include "RequesterCreationException.h"
#include "ResponderCreationException.h"
#include "Response.h"
32
#include "Serializer.h"
33
#include "Services.h"
legoc's avatar
legoc committed
34
#include "TimeCondition.h"
35
#include "EventListener.h"
legoc's avatar
legoc committed
36
37
38
39

namespace cameo {

enum Option {
legoc's avatar
legoc committed
40
41
	NONE = 0,
	OUTPUTSTREAM = 1
legoc's avatar
legoc committed
42
43
44
45
};

class Server;
class EventStreamSocket;
legoc's avatar
legoc committed
46
class OutputStreamSocket;
legoc's avatar
legoc committed
47
48
49
50
51
52
53
54
55
class PublisherImpl;
class SubscriberImpl;
class RequestImpl;
class ResponderImpl;
class RequesterImpl;
class WaitingImpl;
class SocketWaitingImpl;
class GenericWaitingImpl;
class WaitingImplSet;
56
class HandlerImpl;
legoc's avatar
legoc committed
57
58
59
60
61
62
63
64
65
66
67
68
69

namespace application {

// forward declarations
class Publisher;
class Subscriber;
class Responder;
class Requester;
class Instance;
class Waiting;

typedef int32_t State;

legoc's avatar
legoc committed
70
71
#undef ERROR

legoc's avatar
legoc committed
72
73
74
75
76
77
const State UNKNOWN = 0;
const State STARTING = 1;
const State RUNNING = 2;
const State STOPPING = 4;
const State KILLING = 8;
const State PROCESSING_ERROR = 16;
legoc's avatar
legoc committed
78
const State FAILURE = 32;
legoc's avatar
legoc committed
79
80
81
82
83
const State SUCCESS = 64;
const State STOPPED = 128;
const State KILLED = 256;


84
class This : private Services, private EventListener {
legoc's avatar
legoc committed
85
86
87
88
89
90
91
92
93
94
95
96
97

	friend class cameo::application::Publisher;
	friend class cameo::application::Responder;
	friend class cameo::application::Requester;
	friend class cameo::PublisherImpl;
	friend class cameo::RequestImpl;
	friend class cameo::ResponderImpl;
	friend class cameo::RequesterImpl;
	friend class cameo::SocketWaitingImpl;
	friend class cameo::GenericWaitingImpl;
	friend class cameo::Server;
	friend std::ostream& operator<<(std::ostream&, const cameo::application::This&);

legoc's avatar
legoc committed
98
	typedef std::function<void ()> StopFunctionType;
legoc's avatar
legoc committed
99
100

public:
101
102
103
	This();
	~This();

legoc's avatar
legoc committed
104
	static void init(int argc, char *argv[]);
105
106
107
108

	/**
	 * The terminate call is not necessary unless the static instance of This is not destroyed automatically.
	 */
legoc's avatar
legoc committed
109
110
111
112
113
114
	static void terminate();

	static const std::string& getName();
	static int getId();
	static void setTimeout(int timeout);
	static int getTimeout();
115
	static const std::string& getEndpoint();
legoc's avatar
legoc committed
116
117
118
119
120
121
122
123
124
125
126
127
	static Server& getServer();

	/**
	 * throws StarterServerException.
	 */
	static Server& getStarterServer();
	static const std::string& getUrl();
	static bool isAvailable(int timeout = 10000);
	static bool isStopping();

	template<typename Type>
	static void handleStop(Type function) {
128
		m_instance.handleStopImpl(function);
legoc's avatar
legoc committed
129
130
131
132
	}

	static void cancelWaitings();

133
	static bool setRunning();
legoc's avatar
legoc committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147

	/**
	 * Sets the result.
	 */
	static void setBinaryResult(const std::string& data);
	static void setResult(const std::string& data);
	static void setResult(const int32_t* data, std::size_t size);
	static void setResult(const int64_t* data, std::size_t size);
	static void setResult(const float* data, std::size_t size);
	static void setResult(const double* data, std::size_t size);

	/**
	 * Connects to the starter application, i.e. the application which started this application.
	 */
legoc's avatar
legoc committed
148
	static std::unique_ptr<Instance> connectToStarter();
legoc's avatar
legoc committed
149
150

private:
151
	void initApplication(int argc, char *argv[]);
legoc's avatar
legoc committed
152

legoc's avatar
legoc committed
153
154
155
	static std::string getReference();
	static State parseState(const std::string& value);
	State getState(int id) const;
legoc's avatar
legoc committed
156
157
158
159

	int initUnmanagedApplication();
	void terminateUnmanagedApplication();

legoc's avatar
legoc committed
160
161
162
	bool destroyPublisher(const std::string& name) const;
	bool removePort(const std::string& name) const;
	State waitForStop();
163
164

	void stoppingFunction(StopFunctionType stop);
legoc's avatar
legoc committed
165
166
	void handleStopImpl(StopFunctionType function);

167
	ServicesImpl * m_impl;
legoc's avatar
legoc committed
168
169
	std::string m_name;
	int m_id;
legoc's avatar
legoc committed
170
	bool m_managed;
legoc's avatar
legoc committed
171
172
173
174
175

	std::string m_starterEndpoint;
	std::string m_starterName;
	int m_starterId;

legoc's avatar
legoc committed
176
177
	std::unique_ptr<Server> m_server;
	std::unique_ptr<Server> m_starterServer;
legoc's avatar
legoc committed
178

legoc's avatar
legoc committed
179
	std::unique_ptr<WaitingImplSet> m_waitingSet;
180
	std::unique_ptr<HandlerImpl> m_stopHandler;
legoc's avatar
legoc committed
181

182
	static This m_instance;
legoc's avatar
legoc committed
183
184
185
186
	static const std::string RUNNING_STATE;
};


187
class Instance : private EventListener {
legoc's avatar
legoc committed
188
189
190
191
192
193

	friend class cameo::Server;
	friend class cameo::application::Subscriber;
	friend std::ostream& operator<<(std::ostream&, const Instance&);

public:
legoc's avatar
legoc committed
194
	typedef std::function<void (State)> StateHandlerType;
legoc's avatar
legoc committed
195

legoc's avatar
legoc committed
196
197
198
199
200
201
202
203
204
205
206
	~Instance();

	int getId() const;
	const std::string& getUrl() const;
	const std::string& getEndpoint() const;
	std::string getNameId() const;
	bool hasResult() const;
	bool exists() const;
	const std::string& getErrorMessage() const;
	bool stop();
	bool kill();
legoc's avatar
legoc committed
207

legoc's avatar
legoc committed
208
209
210
	State waitFor(StateHandlerType handler = nullptr);
	State waitFor(int states, StateHandlerType handler = nullptr);
	State waitFor(int states, const std::string& eventName, StateHandlerType handler = nullptr);
legoc's avatar
legoc committed
211

legoc's avatar
legoc committed
212
213
	void cancelWaitFor();

214
215
216
217
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
218
219
	State now();

220
221
222
223
224
225
226
227
228
229
	/**
	 * Gets the last state.
	 */
	State getLastState();

	/**
	 * Returns the actual state and UNKNOWN if the instance does not exist anymore.
	 */
	State getActualState() const;

legoc's avatar
legoc committed
230
231
232
233
234
235
236
	bool getBinaryResult(std::string& result);
	bool getResult(std::string& result);
	bool getResult(std::vector<int32_t>& result);
	bool getResult(std::vector<int64_t>& result);
	bool getResult(std::vector<float>& result);
	bool getResult(std::vector<double>& result);

legoc's avatar
legoc committed
237
238
	std::shared_ptr<OutputStreamSocket> getOutputStreamSocket();

legoc's avatar
legoc committed
239
private:
240
	Instance(Server * server);
legoc's avatar
legoc committed
241
242
243

	void setId(int id);
	void setErrorMessage(const std::string& message);
legoc's avatar
legoc committed
244
	void setOutputStreamSocket(std::unique_ptr<OutputStreamSocket>& socket);
legoc's avatar
legoc committed
245
246
	void setPastStates(State pastStates);
	void setInitialState(State state);
247
	State waitFor(int states, const std::string& eventName, StateHandlerType handler, bool blocking);
legoc's avatar
legoc committed
248

249
	Server * m_server;
legoc's avatar
legoc committed
250
	std::shared_ptr<OutputStreamSocket> m_outputStreamSocket;
legoc's avatar
legoc committed
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
	int m_id;
	std::string m_errorMessage;
	int m_pastStates;
	State m_initialState;
	State m_lastState;
	bool m_hasResult;
	std::string m_resultData;
};

///////////////////////////////////////////////////////////////////////////
// InstanceArray

class InstanceArray {

	friend class cameo::Server;

public:
	InstanceArray(const InstanceArray& array);
	~InstanceArray();

	std::size_t size() const;
legoc's avatar
legoc committed
272
	std::unique_ptr<Instance>& operator[](std::size_t index);
legoc's avatar
legoc committed
273
274
275
276
277
278

private:
	InstanceArray();
	void allocate(std::size_t size);

	std::size_t m_size;
legoc's avatar
legoc committed
279
	std::unique_ptr<Instance>* m_array;
legoc's avatar
legoc committed
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
};

///////////////////////////////////////////////////////////////////////////
// Publisher

class Publisher {

	friend class cameo::application::This;
	friend std::ostream& operator<<(std::ostream&, const Publisher&);

public:
	~Publisher();

	/**
	 * Returns the publisher with name.
	 * throws PublisherCreationException.
	 */
legoc's avatar
legoc committed
297
	static std::unique_ptr<Publisher> create(const std::string& name, int numberOfSubscribers = 0);
legoc's avatar
legoc committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315

	const std::string& getName() const;
	const std::string& getApplicationName() const;
	int getApplicationId() const;
	const std::string& getApplicationEndpoint() const;

	/**
	 * Returns true if the wait succeeds or false if it was canceled.
	 */
	bool waitForSubscribers() const;
	void cancelWaitForSubscribers();

	void sendBinary(const std::string& data) const;
	void send(const std::string& data) const;
	void send(const int32_t* data, std::size_t size) const;
	void send(const int64_t* data, std::size_t size) const;
	void send(const float* data, std::size_t size) const;
	void send(const double* data, std::size_t size) const;
316
	void sendTwoBinaryParts(const std::string& data1, const std::string& data2) const;
legoc's avatar
legoc committed
317
	void sendEnd() const;
318
319
320
321
322

	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
legoc's avatar
legoc committed
323
324
	bool hasEnded() const;

325
326
	bool isEnded() const;

legoc's avatar
legoc committed
327
328
329
private:
	Publisher(const application::This * application, int publisherPort, int synchronizerPort, const std::string& name, int numberOfSubscribers);

legoc's avatar
legoc committed
330
331
	std::unique_ptr<PublisherImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
};

///////////////////////////////////////////////////////////////////////////
// Subscriber

class Subscriber {

	friend class cameo::Server;
	friend class cameo::application::Instance;
	friend std::ostream& operator<<(std::ostream&, const Subscriber&);

public:
	~Subscriber();

legoc's avatar
legoc committed
346
	static std::unique_ptr<Subscriber> create(Instance & instance, const std::string& publisherName);
legoc's avatar
legoc committed
347
348
349
350
351
352

	const std::string& getPublisherName() const;
	const std::string& getInstanceName() const;
	int getInstanceId() const;
	const std::string& getInstanceEndpoint() const;

353
354
355
356
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
legoc's avatar
legoc committed
357
358
	bool hasEnded() const;

359
360
361
	bool isEnded() const;
	bool isCanceled() const;

legoc's avatar
legoc committed
362
363
364
365
366
367
368
369
370
	/**
	 * Returns false if the stream finishes.
	 */
	bool receiveBinary(std::string& data) const;
	bool receive(std::string& data) const;
	bool receive(std::vector<int32_t>& data) const;
	bool receive(std::vector<int64_t>& data) const;
	bool receive(std::vector<float>& data) const;
	bool receive(std::vector<double>& data) const;
371
	bool receiveTwoBinaryParts(std::string& data1, std::string& data2) const;
legoc's avatar
legoc committed
372
373
374
375
376
377
378

	void cancel();

private:
	Subscriber(const Server * server, const std::string& url, int publisherPort, int synchronizerPort, const std::string& publisherName, int numberOfSubscribers, const std::string& instanceName, int instanceId, const std::string& instanceEndpoint, const std::string& statusEndpoint);
	void init();

legoc's avatar
legoc committed
379
380
	std::unique_ptr<SubscriberImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
381
382
383
384
385
386
387
388
389
390
391
392
393
};

///////////////////////////////////////////////////////////////////////////
// Request

class Request {

	friend class cameo::application::Responder;
	friend std::ostream& operator<<(std::ostream&, const Request&);

public:
	~Request();

394
395
396
	const std::string& getBinary() const;
	std::string get() const;
	const std::string& getSecondBinaryPart() const;
legoc's avatar
legoc committed
397

legoc's avatar
legoc committed
398
399
	void replyBinary(const std::string& response);
	void reply(const std::string& response);
legoc's avatar
legoc committed
400

legoc's avatar
legoc committed
401
	std::unique_ptr<Instance> connectToRequester();
402

legoc's avatar
legoc committed
403
404
405
	/**
	 * Transfers the ownership of the requester server.
	 */
legoc's avatar
legoc committed
406
	std::unique_ptr<Server> getServer();
legoc's avatar
legoc committed
407

legoc's avatar
legoc committed
408
private:
legoc's avatar
legoc committed
409
	Request(std::unique_ptr<RequestImpl> & impl);
legoc's avatar
legoc committed
410

legoc's avatar
legoc committed
411
412
	std::unique_ptr<RequestImpl> m_impl;
	std::unique_ptr<Server> m_requesterServer;
legoc's avatar
legoc committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
};

///////////////////////////////////////////////////////////////////////////
// Responder

class Responder {

	friend std::ostream& operator<<(std::ostream&, const Responder&);

public:
	~Responder();

	/**
	 * Returns the responder with name.
	 * throws ResponderCreationException.
	 */
legoc's avatar
legoc committed
429
	static std::unique_ptr<Responder> create(const std::string& name);
legoc's avatar
legoc committed
430
431
432
433

	const std::string& getName() const;

	void cancel();
legoc's avatar
legoc committed
434
	std::unique_ptr<Request> receive();
435
436

	bool isCanceled() const;
legoc's avatar
legoc committed
437
438
439
440

private:
	Responder(const application::This * application, int responderPort, const std::string& name);

legoc's avatar
legoc committed
441
442
	std::unique_ptr<ResponderImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
};

///////////////////////////////////////////////////////////////////////////
// Requester

class Requester {

friend std::ostream& operator<<(std::ostream&, const Requester&);

public:
	~Requester();

	/**
	 * Returns the responder with name.
	 * throws RequesterCreationException.
	 */
legoc's avatar
legoc committed
459
	static std::unique_ptr<Requester> create(Instance & instance, const std::string& name);
legoc's avatar
legoc committed
460
461
462
463
464

	const std::string& getName() const;

	void sendBinary(const std::string& request);
	void send(const std::string& request);
465
	void sendTwoBinaryParts(const std::string& request1, const std::string& request2);
legoc's avatar
legoc committed
466
467
468
469
470
471

	bool receiveBinary(std::string& response);
	bool receive(std::string& response);

	void cancel();

472
473
	bool isCanceled() const;

legoc's avatar
legoc committed
474
private:
475
	Requester(const application::This * application, const std::string& url, int requesterPort, int responderPort, const std::string& name, int responderId, int requesterId);
legoc's avatar
legoc committed
476

legoc's avatar
legoc committed
477
478
	std::unique_ptr<RequesterImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
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
};

///////////////////////////////////////////////////////////////////////////
// Configuration

class Configuration {

	friend std::ostream& operator<<(std::ostream&, const Configuration&);

public:
	Configuration(const std::string& name, const std::string& description, bool singleInfo, bool restart, int startingTime, int retries, int stoppingTime);

	const std::string& getName() const;
	const std::string& getDescription() const;
	bool hasSingleInstance() const;
	bool canRestart() const;
	int getStartingTime() const;
	int getRetries() const;
	int getStoppingTime() const;

private:
	std::string m_name;
	std::string m_description;
	bool m_singleInstance;
	bool m_restart;
	int m_startingTime;
	int m_retries;
	int m_stoppingTime;
};

///////////////////////////////////////////////////////////////////////////
// Info

class Info {

	friend std::ostream& operator<<(std::ostream&, const Info&);

public:
legoc's avatar
legoc committed
517
	Info(const std::string& name, int id, int pid, State applicationState, State pastApplicationStates, const std::string& args);
legoc's avatar
legoc committed
518
519
520
521
522
523

	int getId() const;
	State getState() const;
	State getPastStates() const;
	const std::string& getArgs() const;
	const std::string& getName() const;
legoc's avatar
legoc committed
524
	int getPid() const;
legoc's avatar
legoc committed
525
526
527

private:
	int m_id;
legoc's avatar
legoc committed
528
	int m_pid;
legoc's avatar
legoc committed
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
	State m_applicationState;
	State m_pastApplicationStates;
	std::string m_processState;
	std::string m_args;
	std::string m_name;
};

std::string toString(cameo::application::State applicationStates);
std::ostream& operator<<(std::ostream&, const cameo::application::This&);
std::ostream& operator<<(std::ostream&, const cameo::application::Instance&);
std::ostream& operator<<(std::ostream&, const cameo::application::Publisher&);
std::ostream& operator<<(std::ostream&, const cameo::application::Subscriber&);
std::ostream& operator<<(std::ostream&, const cameo::application::Request&);
std::ostream& operator<<(std::ostream&, const cameo::application::Responder&);
std::ostream& operator<<(std::ostream&, const cameo::application::Requester&);
std::ostream& operator<<(std::ostream&, const cameo::application::Configuration&);
std::ostream& operator<<(std::ostream&, const cameo::application::Info&);

}
}


#endif