Application.h 16 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 {
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

75
76
77
78
79
const State UNKNOWN          = 0;
const State STARTING         = 1;
const State RUNNING          = 2;
const State STOPPING         = 4;
const State KILLING          = 8;
legoc's avatar
legoc committed
80
const State PROCESSING_ERROR = 16;
81
82
83
84
85
86
87
88
89
90
91
const State FAILURE          = 32;
const State SUCCESS          = 64;
const State STOPPED          = 128;
const State KILLED           = 256;

/** \class This
 * \brief class managing the current CAMEO application.
 *
 * \details The application has to be launched by CAMEO command line or another CAMEO app
 * \todo why this does not inherit from the Instance class?
 */
92
class This : private Services, private EventListener {
legoc's avatar
legoc committed
93
94
95
96
97
98
99
100
101
102
103
104
105

	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&);

106
	typedef std::function<void()> StopFunctionType;
legoc's avatar
legoc committed
107
108

public:
109
110
111
112
113
114
115
116
117
118
119
120
	/**
	 * 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;

121
122
123
124
		int requestPort() const;
		void setPortUnavailable(int port) const;
		void releasePort(int port) const;

125
	private:
126
		Com(Server* server, int applicationId);
127

128
		Server* m_server;
129
130
131
		int m_applicationId;
	};

132
133
134
	This();
	~This();

135
	static void init(int argc, char* argv[]);
136
	static void init(const std::string& name, const std::string& endpoint);
137
138

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

144
145
146
	/// \brief returns the name of the CAMEO application corresponding to this instance
	static const std::string& getName(); 
	static int getId(); ///< returns the ID number of the instance
legoc's avatar
legoc committed
147
148
	static void setTimeout(int timeout);
	static int getTimeout();
149
	static const Endpoint& getEndpoint(); ///< returns the TCP address of this instance
legoc's avatar
legoc committed
150
	static Server& getServer();
151
	static const Com& getCom();
legoc's avatar
legoc committed
152
153
154
155
156
157
158
159

	/**
	 * throws StarterServerException.
	 */
	static Server& getStarterServer();
	static bool isAvailable(int timeout = 10000);
	static bool isStopping();

160
	/**
161
162
	 * Sets the stop handler with stopping time that overrides the one that may be defined in the
	 * configuration of the server.
163
	 */
164
	template <typename Type>
165
166
	static void handleStop(Type function, int stoppingTime = -1) {
		m_instance.handleStopImpl(function, stoppingTime);
legoc's avatar
legoc committed
167
168
169
170
	}

	static void cancelWaitings();

171
	static bool setRunning(); ///< sets the current instance in RUNNING state
legoc's avatar
legoc committed
172
173
174
175
176
177
178
179
180
181

	/**
	 * 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
182
	static std::unique_ptr<Instance> connectToStarter();
legoc's avatar
legoc committed
183
184

private:
185
	void initApplication(int argc, char* argv[]);
186
	void initApplication(const std::string& name, const std::string& endpoint);
legoc's avatar
legoc committed
187

legoc's avatar
legoc committed
188
189
	static State parseState(const std::string& value);
	State getState(int id) const;
legoc's avatar
legoc committed
190
191
192
193

	int initUnmanagedApplication();
	void terminateUnmanagedApplication();

legoc's avatar
legoc committed
194
195
196
	bool destroyPublisher(const std::string& name) const;
	bool removePort(const std::string& name) const;
	State waitForStop();
197
198

	void stoppingFunction(StopFunctionType stop);
199
	void handleStopImpl(StopFunctionType function, int stoppingTime);
legoc's avatar
legoc committed
200
201
202

	std::string m_name;
	int m_id;
legoc's avatar
legoc committed
203
	bool m_managed;
legoc's avatar
legoc committed
204

legoc's avatar
legoc committed
205
	Endpoint m_starterEndpoint;
legoc's avatar
legoc committed
206
207
208
	std::string m_starterName;
	int m_starterId;

legoc's avatar
legoc committed
209
210
	std::unique_ptr<Server> m_server;
	std::unique_ptr<Server> m_starterServer;
211
	std::unique_ptr<Com> m_com;
legoc's avatar
legoc committed
212

legoc's avatar
legoc committed
213
	std::unique_ptr<WaitingImplSet> m_waitingSet;
214
	std::unique_ptr<HandlerImpl> m_stopHandler;
legoc's avatar
legoc committed
215

216
	static This m_instance;
legoc's avatar
legoc committed
217
218
219
220
	static const std::string RUNNING_STATE;
};


221
class Instance : private EventListener {
legoc's avatar
legoc committed
222
223
224
225
226
227

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

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

230
231
232
233
234
235
236
237
	class Com {

		friend class Instance;

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

	private:
238
		Com(Server* server);
239

240
		Server* m_server;
241
242
243
		int m_applicationId;
	};

legoc's avatar
legoc committed
244
245
	~Instance();

legoc's avatar
legoc committed
246
	const std::string& getName() const;
legoc's avatar
legoc committed
247
	int getId() const;
248
	const Endpoint& getEndpoint() const;
legoc's avatar
legoc committed
249
	std::string getNameId() const;
250
251
	const Com& getCom() const;

legoc's avatar
legoc committed
252
253
254
255
256
	bool hasResult() const;
	bool exists() const;
	const std::string& getErrorMessage() const;
	bool stop();
	bool kill();
legoc's avatar
legoc committed
257

legoc's avatar
legoc committed
258
259
	State waitFor(StateHandlerType handler = nullptr);
	State waitFor(int states, StateHandlerType handler = nullptr);
260
	State waitFor(const std::string& eventName);
261
	State waitFor(KeyValue& keyValue);
legoc's avatar
legoc committed
262

263
	void cancelWaitFor(); // to unblock another instance
legoc's avatar
legoc committed
264

265
266
267
268
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
269
270
	State now();

271
272
273
274
275
276
277
278
279
280
	/**
	 * Gets the last state.
	 */
	State getLastState();

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

281
282
283
284
285
	/**
	 * Returns the past states.
	 */
	std::set<State> getPastStates() const;

286
287
288
289
290
	/**
	 * Returns the exit code.
	 */
	int getExitCode() const;

legoc's avatar
legoc committed
291
292
293
	bool getBinaryResult(std::string& result);
	bool getResult(std::string& result);

legoc's avatar
legoc committed
294
295
	std::shared_ptr<OutputStreamSocket> getOutputStreamSocket();

legoc's avatar
legoc committed
296
private:
297
	Instance(Server* server);
legoc's avatar
legoc committed
298
299
300

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

306
	Server* m_server;
legoc's avatar
legoc committed
307
	std::shared_ptr<OutputStreamSocket> m_outputStreamSocket;
legoc's avatar
legoc committed
308
309
	int m_id;
	std::string m_errorMessage;
310
311
	Com m_com;

legoc's avatar
legoc committed
312
313
314
315
316
	int m_pastStates;
	State m_initialState;
	State m_lastState;
	bool m_hasResult;
	std::string m_resultData;
317
	int m_exitCode;
318
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
319
320
321
322
323
324
325
326
327
328
329
330
331
332
};

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

class InstanceArray {

	friend class cameo::Server;

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

	std::size_t size() const;
legoc's avatar
legoc committed
333
	std::unique_ptr<Instance>& operator[](std::size_t index);
legoc's avatar
legoc committed
334
335
336
337
338
339

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

	std::size_t m_size;
legoc's avatar
legoc committed
340
	std::unique_ptr<Instance>* m_array;
legoc's avatar
legoc committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
};

///////////////////////////////////////////////////////////////////////////
// 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
358
	static std::unique_ptr<Publisher> create(const std::string& name, int numberOfSubscribers = 0);
legoc's avatar
legoc committed
359
360
361
362

	const std::string& getName() const;
	const std::string& getApplicationName() const;
	int getApplicationId() const;
363
	std::string getApplicationEndpoint() const;
legoc's avatar
legoc committed
364
365
366
367
368
369
370
371
372

	/**
	 * 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;
373
	void sendTwoBinaryParts(const std::string& data1, const std::string& data2) const;
legoc's avatar
legoc committed
374
	void sendEnd() const;
375
376
377
378
379

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

382
383
	bool isEnded() const;

legoc's avatar
legoc committed
384
private:
385
386
	Publisher(application::This* application, int publisherPort, int synchronizerPort,
		  const std::string& name, int numberOfSubscribers);
legoc's avatar
legoc committed
387

legoc's avatar
legoc committed
388
389
	std::unique_ptr<PublisherImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
};

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

class Subscriber {

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

public:
	~Subscriber();

404
	static std::unique_ptr<Subscriber> create(Instance& instance, const std::string& publisherName);
legoc's avatar
legoc committed
405
406
407
408
409
410

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

411
412
413
414
	/**
	 * Deprecated.
	 * TODO remove in next version.
	 */
legoc's avatar
legoc committed
415
416
	bool hasEnded() const;

417
418
419
	bool isEnded() const;
	bool isCanceled() const;

legoc's avatar
legoc committed
420
421
422
423
424
	/**
	 * Returns false if the stream finishes.
	 */
	bool receiveBinary(std::string& data) const;
	bool receive(std::string& data) const;
425
	bool receiveTwoBinaryParts(std::string& data1, std::string& data2) const;
legoc's avatar
legoc committed
426
427
428
429

	void cancel();

private:
430
431
432
	Subscriber(Server* server, 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
433
434
	void init();

legoc's avatar
legoc committed
435
436
	std::unique_ptr<SubscriberImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
437
438
439
440
441
442
443
444
445
446
447
448
449
};

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

class Request {

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

public:
	~Request();

legoc's avatar
legoc committed
450
	std::string getObjectId() const;
451
	std::string getRequesterEndpoint() const;
legoc's avatar
legoc committed
452

453
454
455
	const std::string& getBinary() const;
	std::string get() const;
	const std::string& getSecondBinaryPart() const;
legoc's avatar
legoc committed
456

legoc's avatar
legoc committed
457
	void setTimeout(int value);
458

legoc's avatar
legoc committed
459
460
	bool replyBinary(const std::string& response);
	bool reply(const std::string& response);
legoc's avatar
legoc committed
461

legoc's avatar
legoc committed
462
	std::unique_ptr<Instance> connectToRequester();
463

legoc's avatar
legoc committed
464
465
466
	/**
	 * Transfers the ownership of the requester server.
	 */
legoc's avatar
legoc committed
467
	std::unique_ptr<Server> getServer();
legoc's avatar
legoc committed
468

legoc's avatar
legoc committed
469
private:
470
	Request(std::unique_ptr<RequestImpl>& impl);
legoc's avatar
legoc committed
471

legoc's avatar
legoc committed
472
473
	std::unique_ptr<RequestImpl> m_impl;
	std::unique_ptr<Server> m_requesterServer;
legoc's avatar
legoc committed
474
475
476
477
478
479
480
481
482
483
484
485
};

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

class Responder {

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

public:
	~Responder();

486
	/** \brief Returns the responder with name.
legoc's avatar
legoc committed
487
488
	 * throws ResponderCreationException.
	 */
legoc's avatar
legoc committed
489
	static std::unique_ptr<Responder> create(const std::string& name);
legoc's avatar
legoc committed
490

491
	/// Returns the name of the responder
legoc's avatar
legoc committed
492
493
494
	const std::string& getName() const;

	void cancel();
495

496
	/** \brief Receive a request
497
498
	 * blocking command
	 */
legoc's avatar
legoc committed
499
	std::unique_ptr<Request> receive();
500

501
	/** check if it has been canceled */
502
	bool isCanceled() const;
legoc's avatar
legoc committed
503
504

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

legoc's avatar
legoc committed
507
508
	std::unique_ptr<ResponderImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
509
510
511
512
513
514
515
};

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

class Requester {

516
	friend std::ostream& operator<<(std::ostream&, const Requester&);
legoc's avatar
legoc committed
517
518
519
520
521
522
523
524

public:
	~Requester();

	/**
	 * Returns the responder with name.
	 * throws RequesterCreationException.
	 */
525
	static std::unique_ptr<Requester> create(Instance& instance, const std::string& name);
legoc's avatar
legoc committed
526
527
528
529
530

	const std::string& getName() const;

	void sendBinary(const std::string& request);
	void send(const std::string& request);
531
	void sendTwoBinaryParts(const std::string& request1, const std::string& request2);
legoc's avatar
legoc committed
532
533
534
535
536
537

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

	void cancel();

538
539
	bool isCanceled() const;

legoc's avatar
legoc committed
540
private:
541
542
	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
543

legoc's avatar
legoc committed
544
545
	std::unique_ptr<RequesterImpl> m_impl;
	std::unique_ptr<WaitingImpl> m_waiting;
legoc's avatar
legoc committed
546
547
548
549
550
551
552
553
554
555
};

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

class Configuration {

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

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

	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:
583
584
	Info(const std::string& name, int id, int pid, State applicationState, State pastApplicationStates,
	     const std::string& args);
legoc's avatar
legoc committed
585
586
587
588
589
590

	int getId() const;
	State getState() const;
	State getPastStates() const;
	const std::string& getArgs() const;
	const std::string& getName() const;
legoc's avatar
legoc committed
591
	int getPid() const;
legoc's avatar
legoc committed
592
593
594

private:
	int m_id;
legoc's avatar
legoc committed
595
	int m_pid;
legoc's avatar
legoc committed
596
597
598
599
600
601
602
	State m_applicationState;
	State m_pastApplicationStates;
	std::string m_processState;
	std::string m_args;
	std::string m_name;
};

603
604
605
606
607
608
609
610
///////////////////////////////////////////////////////////////////////////
// Port

class Port {

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

public:
legoc's avatar
legoc committed
611
	Port(int port, const std::string& status, const std::string& owner);
612
613
614

	int getPort() const;
	const std::string& getStatus() const;
legoc's avatar
legoc committed
615
	const std::string& getOwner() const;
616
617
618
619

private:
	int m_port;
	std::string m_status;
legoc's avatar
legoc committed
620
	std::string m_owner;
621
622
};

legoc's avatar
legoc committed
623
624
625
626
627
628
629
630
631
632
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&);
633
std::ostream& operator<<(std::ostream&, const cameo::application::Port&);
legoc's avatar
legoc committed
634

635
636
} // namespace application
} // namespace cameo
legoc's avatar
legoc committed
637
638

#endif