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
|
/*=========================================================================
Program: ParaView
Module: vtkNetworkAccessManager.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkNetworkAccessManager
*
* vtkNetworkAccessManager is used to create new connections and monitor
* activity of those connections. This is an abstract class that defines the
* interface. Concrete implementations of this class can be written to support
* tcp/ip socket or ssl or ssh based network connections among processes.
*/
#ifndef vtkNetworkAccessManager_h
#define vtkNetworkAccessManager_h
#include "vtkObject.h"
#include "vtkPVClientServerCoreCoreModule.h" //needed for exports
class vtkMultiProcessController;
class VTKPVCLIENTSERVERCORECORE_EXPORT vtkNetworkAccessManager : public vtkObject
{
public:
vtkTypeMacro(vtkNetworkAccessManager, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Creates a new connection given the url.
* This call may block until the connection can be established. To keep
* user-interfaces responsive, one can listen to the vtkCommand::ProgressEvent
* fired periodically by this class while waiting.
* vtkNetworkAccessManager can be waiting for atmost one connection at a
* time. Calling NewConnection() while another connection is pending will
* raise an error.
* To abort the connection and cancel the waiting, simply call
* AbortPendingConnection() in the vtkCommand::ProgressEvent callback.
* Returns the new connection instance on success, otherwise NULL.
* URLs are of the following form:
* \p \<transport\>://\<address\>
* * \p tcp://\<hostname\>:\<port\>
* * \p tcp://localhost:\<port\>/listen -- listen for connection on port.
* * \p tcp://localhost:\<port\>/listenmultiple -- listen for multiple
* Examples:
* * \p tcp://medea:12345
* * \p tcp://localhost:12345/listen
* * \p ssh://utkarsh\@medea
* * http://kitware-server/session?id=12322&authorization=12
*/
virtual vtkMultiProcessController* NewConnection(const char* url) = 0;
/**
* Used to abort pending connection creation, if any. Refer to
* NewConnection() for details.
*/
virtual void AbortPendingConnection() = 0;
/**
* Process any network activity.
*/
virtual int ProcessEvents(unsigned long timeout_msecs) = 0;
/**
* Peeks to check if any activity is available. When this call returns true,
* ProcessEvents() will always result in some activity processing if called
* afterword.
*/
virtual bool GetNetworkEventsAvailable() = 0;
/**
* Returns true is the manager is currently waiting for any connections.
*/
virtual bool GetPendingConnectionsPresent() = 0;
protected:
vtkNetworkAccessManager();
~vtkNetworkAccessManager();
private:
vtkNetworkAccessManager(const vtkNetworkAccessManager&) VTK_DELETE_FUNCTION;
void operator=(const vtkNetworkAccessManager&) VTK_DELETE_FUNCTION;
};
#endif
|
