Application.h 15 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
#include "ConnectionTimeout.h"
#include "PublisherCreationException.h"
#include "RequesterCreationException.h"
#include "ResponderCreationException.h"
31
32
#include "UndefinedApplicationException.h"
#include "UndefinedKeyException.h"
33
#include "Response.h"
34
#include "Serializer.h"
35
#include "Services.h"
legoc's avatar
legoc committed
36
#include "TimeCondition.h"
37
#include "EventListener.h"
38
#include "KeyValue.h"
legoc's avatar
legoc committed
39
40
41
42

namespace cameo {

enum Option {
legoc's avatar
legoc committed
43
44
	NONE = 0,
	OUTPUTSTREAM = 1
legoc's avatar
legoc committed
45
46
47
48
};

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

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
73
74
#undef ERROR

legoc's avatar
legoc committed
75
76
77
78
79
80
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
81
const State FAILURE = 32;
legoc's avatar
legoc committed
82
83
84
85
86
const State SUCCESS = 64;
const State STOPPED = 128;
const State KILLED = 256;


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

	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
101
	typedef std::function<void ()> StopFunctionType;
legoc's avatar
legoc committed
102
103

public:
104
105
106
107
108
109
110
111
112
113
114
115
	/**
	 * Class defining the Communication Operations Manager (COM).
	 */
	class Com {

		friend class This;

	public:
		void storeKeyValue(const std::string& key, const std::string& value) const;
		std::string getKeyValue(const std::string& key) const;
		void removeKey(const std::string& key) const;

116
117
118
119
		int requestPort() const;
		void setPortUnavailable(int port) const;
		void releasePort(int port) const;

120
121
122
123
124
125
126
	private:
		Com(Server * server, int applicationId);

		Server * m_server;
		int m_applicationId;
	};

127
128
129
	This();
	~This();

legoc's avatar
legoc committed
130
	static void init(int argc, char *argv[]);
131
132
133
134

	/**
	 * The terminate call is not necessary unless the static instance of This is not destroyed automatically.
	 */
legoc's avatar
legoc committed
135
136
137
138
139
140
	static void terminate();

	static const std::string& getName();
	static int getId();
	static void setTimeout(int timeout);
	static int getTimeout();
141
	static const std::string& getEndpoint();
legoc's avatar
legoc committed
142
	static Server& getServer();
143
	static const Com& getCom();
legoc's avatar
legoc committed
144
145
146
147
148
149
150
151
152
153
154

	/**
	 * 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) {
155
		m_instance.handleStopImpl(function);
legoc's avatar
legoc committed
156
157
158
159
	}

	static void cancelWaitings();

160
	static bool setRunning();
legoc's avatar
legoc committed
161
162
163
164
165
166
167
168
169
170

	/**
	 * Sets the result.
	 */
	static void setBinaryResult(const std::string& data);
	static void setResult(const std::string& data);

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

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

legoc's avatar
legoc committed
176
177
178
	static std::string getReference();
	static State parseState(const std::string& value);
	State getState(int id) const;
legoc's avatar
legoc committed
179
180
181
182

	int initUnmanagedApplication();
	void terminateUnmanagedApplication();

legoc's avatar
legoc committed
183
184
185
	bool destroyPublisher(const std::string& name) const;
	bool removePort(const std::string& name) const;
	State waitForStop();
186
187

	void stoppingFunction(StopFunctionType stop);
legoc's avatar
legoc committed
188
189
190
191
	void handleStopImpl(StopFunctionType function);

	std::string m_name;
	int m_id;
legoc's avatar
legoc committed
192
	bool m_managed;
legoc's avatar
legoc committed
193
194
195
196
197

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

legoc's avatar
legoc committed
198
199
	std::unique_ptr<Server> m_server;
	std::unique_ptr<Server> m_starterServer;
200
	std::unique_ptr<Com> m_com;
legoc's avatar
legoc committed
201

legoc's avatar
legoc committed
202
	std::unique_ptr<WaitingImplSet> m_waitingSet;
203
	std::unique_ptr<HandlerImpl> m_stopHandler;
legoc's avatar
legoc committed
204

205
	static This m_instance;
legoc's avatar
legoc committed
206
207
208
209
	static const std::string RUNNING_STATE;
};


210
class Instance : private EventListener {
legoc's avatar
legoc committed
211
212
213
214
215
216

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

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

219
220
221
222
223
224
225
226
227
228
229
230
231
232
	class Com {

		friend class Instance;

	public:
		std::string getKeyValue(const std::string& key) const;

	private:
		Com(Server * server);

		Server * m_server;
		int m_applicationId;
	};

legoc's avatar
legoc committed
233
234
	~Instance();

legoc's avatar
legoc committed
235
	const std::string& getName() const;
legoc's avatar
legoc committed
236
237
238
239
	int getId() const;
	const std::string& getUrl() const;
	const std::string& getEndpoint() const;
	std::string getNameId() const;
240
241
	const Com& getCom() const;

legoc's avatar
legoc committed
242
243
244
245
246
	bool hasResult() const;
	bool exists() const;
	const std::string& getErrorMessage() const;
	bool stop();
	bool kill();
legoc's avatar
legoc committed
247

legoc's avatar
legoc committed
248
249
	State waitFor(StateHandlerType handler = nullptr);
	State waitFor(int states, StateHandlerType handler = nullptr);
250
	State waitFor(const std::string& eventName);
251
	State waitFor(KeyValue& keyValue);
legoc's avatar
legoc committed
252

legoc's avatar
legoc committed
253
254
	void cancelWaitFor();

255
256
257
258
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
259
260
	State now();

261
262
263
264
265
266
267
268
269
270
	/**
	 * Gets the last state.
	 */
	State getLastState();

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

271
272
273
274
275
	/**
	 * Returns the past states.
	 */
	std::set<State> getPastStates() const;

276
277
278
279
280
	/**
	 * Returns the exit code.
	 */
	int getExitCode() const;

legoc's avatar
legoc committed
281
282
283
	bool getBinaryResult(std::string& result);
	bool getResult(std::string& result);

legoc's avatar
legoc committed
284
285
	std::shared_ptr<OutputStreamSocket> getOutputStreamSocket();

legoc's avatar
legoc committed
286
private:
287
	Instance(Server * server);
legoc's avatar
legoc committed
288
289
290

	void setId(int id);
	void setErrorMessage(const std::string& message);
legoc's avatar
legoc committed
291
	void setOutputStreamSocket(std::unique_ptr<OutputStreamSocket>& socket);
legoc's avatar
legoc committed
292
293
	void setPastStates(State pastStates);
	void setInitialState(State state);
294
	State waitFor(int states, const std::string& eventName, KeyValue& keyValue, StateHandlerType handler, bool blocking);
legoc's avatar
legoc committed
295

296
	Server * m_server;
legoc's avatar
legoc committed
297
	std::shared_ptr<OutputStreamSocket> m_outputStreamSocket;
legoc's avatar
legoc committed
298
299
	int m_id;
	std::string m_errorMessage;
300
301
	Com m_com;

legoc's avatar
legoc committed
302
303
304
305
306
	int m_pastStates;
	State m_initialState;
	State m_lastState;
	bool m_hasResult;
	std::string m_resultData;
307
	int m_exitCode;
308
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
309
310
311
312
313
314
315
316
317
318
319
320
321
322
};

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

class InstanceArray {

	friend class cameo::Server;

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

	std::size_t size() const;
legoc's avatar
legoc committed
323
	std::unique_ptr<Instance>& operator[](std::size_t index);
legoc's avatar
legoc committed
324
325
326
327
328
329

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

	std::size_t m_size;
legoc's avatar
legoc committed
330
	std::unique_ptr<Instance>* m_array;
legoc's avatar
legoc committed
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
};

///////////////////////////////////////////////////////////////////////////
// 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
348
	static std::unique_ptr<Publisher> create(const std::string& name, int numberOfSubscribers = 0);
legoc's avatar
legoc committed
349
350
351
352
353
354
355
356
357
358
359
360
361
362

	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;
363
	void sendTwoBinaryParts(const std::string& data1, const std::string& data2) const;
legoc's avatar
legoc committed
364
	void sendEnd() const;
365
366
367
368
369

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

372
373
	bool isEnded() const;

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

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

///////////////////////////////////////////////////////////////////////////
// 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
393
	static std::unique_ptr<Subscriber> create(Instance & instance, const std::string& publisherName);
legoc's avatar
legoc committed
394
395
396
397
398
399

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

400
401
402
403
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
legoc's avatar
legoc committed
404
405
	bool hasEnded() const;

406
407
408
	bool isEnded() const;
	bool isCanceled() const;

legoc's avatar
legoc committed
409
410
411
412
413
	/**
	 * Returns false if the stream finishes.
	 */
	bool receiveBinary(std::string& data) const;
	bool receive(std::string& data) const;
414
	bool receiveTwoBinaryParts(std::string& data1, std::string& data2) const;
legoc's avatar
legoc committed
415
416
417
418

	void cancel();

private:
419
	Subscriber(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);
legoc's avatar
legoc committed
420
421
	void init();

legoc's avatar
legoc committed
422
423
	std::unique_ptr<SubscriberImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
424
425
426
427
428
429
430
431
432
433
434
435
436
};

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

class Request {

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

public:
	~Request();

legoc's avatar
legoc committed
437
	std::string getObjectId() const;
438
	std::string getRequesterEndpoint() const;
legoc's avatar
legoc committed
439

440
441
442
	const std::string& getBinary() const;
	std::string get() const;
	const std::string& getSecondBinaryPart() const;
legoc's avatar
legoc committed
443

legoc's avatar
legoc committed
444
	void setTimeout(int value);
445

legoc's avatar
legoc committed
446
447
	bool replyBinary(const std::string& response);
	bool reply(const std::string& response);
legoc's avatar
legoc committed
448

legoc's avatar
legoc committed
449
	std::unique_ptr<Instance> connectToRequester();
450

legoc's avatar
legoc committed
451
452
453
	/**
	 * Transfers the ownership of the requester server.
	 */
legoc's avatar
legoc committed
454
	std::unique_ptr<Server> getServer();
legoc's avatar
legoc committed
455

legoc's avatar
legoc committed
456
private:
legoc's avatar
legoc committed
457
	Request(std::unique_ptr<RequestImpl> & impl);
legoc's avatar
legoc committed
458

legoc's avatar
legoc committed
459
460
	std::unique_ptr<RequestImpl> m_impl;
	std::unique_ptr<Server> m_requesterServer;
legoc's avatar
legoc committed
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
};

///////////////////////////////////////////////////////////////////////////
// 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
477
	static std::unique_ptr<Responder> create(const std::string& name);
legoc's avatar
legoc committed
478
479
480
481

	const std::string& getName() const;

	void cancel();
legoc's avatar
legoc committed
482
	std::unique_ptr<Request> receive();
483
484

	bool isCanceled() const;
legoc's avatar
legoc committed
485
486

private:
legoc's avatar
legoc committed
487
	Responder(application::This * application, int responderPort, const std::string& name);
legoc's avatar
legoc committed
488

legoc's avatar
legoc committed
489
490
	std::unique_ptr<ResponderImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
};

///////////////////////////////////////////////////////////////////////////
// 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
507
	static std::unique_ptr<Requester> create(Instance & instance, const std::string& name);
legoc's avatar
legoc committed
508
509
510
511
512

	const std::string& getName() const;

	void sendBinary(const std::string& request);
	void send(const std::string& request);
513
	void sendTwoBinaryParts(const std::string& request1, const std::string& request2);
legoc's avatar
legoc committed
514
515
516
517
518
519

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

	void cancel();

520
521
	bool isCanceled() const;

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

legoc's avatar
legoc committed
525
526
	std::unique_ptr<RequesterImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
527
528
529
530
531
532
533
534
535
536
};

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

class Configuration {

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

public:
537
	Configuration(const std::string& name, const std::string& description, bool singleInfo, bool restart, int startingTime, int stoppingTime);
legoc's avatar
legoc committed
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

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

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

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

class Info {

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

public:
legoc's avatar
legoc committed
563
	Info(const std::string& name, int id, int pid, State applicationState, State pastApplicationStates, const std::string& args);
legoc's avatar
legoc committed
564
565
566
567
568
569

	int getId() const;
	State getState() const;
	State getPastStates() const;
	const std::string& getArgs() const;
	const std::string& getName() const;
legoc's avatar
legoc committed
570
	int getPid() const;
legoc's avatar
legoc committed
571
572
573

private:
	int m_id;
legoc's avatar
legoc committed
574
	int m_pid;
legoc's avatar
legoc committed
575
576
577
578
579
580
581
	State m_applicationState;
	State m_pastApplicationStates;
	std::string m_processState;
	std::string m_args;
	std::string m_name;
};

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
///////////////////////////////////////////////////////////////////////////
// Port

class Port {

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

public:
	Port(int port, const std::string& status, const std::string& application);

	int getPort() const;
	const std::string& getStatus() const;
	const std::string& getApplication() const;

private:
	int m_port;
	std::string m_status;
	std::string m_application;
};

legoc's avatar
legoc committed
602
603
604
605
606
607
608
609
610
611
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&);
612
std::ostream& operator<<(std::ostream&, const cameo::application::Port&);
legoc's avatar
legoc committed
613
614
615
616
617
618

}
}


#endif