#include <vtkTCPNetworkAccessManager.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual vtkMultiProcessController * | NewConnection (const char *url) |
| virtual void | AbortPendingConnection () |
| virtual int | ProcessEvents (unsigned long timeout_msecs) |
| virtual bool | GetNetworkEventsAvailable () |
| virtual bool | GetPendingConnectionsPresent () |
Static Public Member Functions | |
| static vtkTCPNetworkAccessManager * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkTCPNetworkAccessManager * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkTCPNetworkAccessManager () | |
| ~vtkTCPNetworkAccessManager () | |
| int | ProcessEventsInternal (unsigned long timeout_msecs, bool do_processing) |
| bool | ParaViewHandshake (vtkMultiProcessController *controller, bool server_side, const char *handshake) |
| vtkMultiProcessController * | ConnectToRemote (const char *hostname, int port, const char *handshake) |
| vtkMultiProcessController * | WaitForConnection (int port, bool once, const char *handshake, bool nonblocking) |
Protected Attributes | |
| bool | AbortPendingConnectionFlag |
Detailed Description
vtkTCPNetworkAccessManager is a concrete implementation of vtkNetworkAccessManager that uses tcp/ip sockets for communication between processes. It supports urls that use "tcp" as their protocol specifier.
Definition at line 29 of file vtkTCPNetworkAccessManager.h.
Constructor & Destructor Documentation
| vtkTCPNetworkAccessManager::vtkTCPNetworkAccessManager | ( | ) | [protected] |
| vtkTCPNetworkAccessManager::~vtkTCPNetworkAccessManager | ( | ) | [protected] |
Member Function Documentation
| static vtkTCPNetworkAccessManager* vtkTCPNetworkAccessManager::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkTCPNetworkAccessManager::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkNetworkAccessManager.
| static int vtkTCPNetworkAccessManager::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkNetworkAccessManager.
| virtual int vtkTCPNetworkAccessManager::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkNetworkAccessManager.
| static vtkTCPNetworkAccessManager* vtkTCPNetworkAccessManager::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkNetworkAccessManager.
| void vtkTCPNetworkAccessManager::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkNetworkAccessManager.
| virtual vtkMultiProcessController* vtkTCPNetworkAccessManager::NewConnection | ( | const char * | url | ) | [virtual] |
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: <transport>://<address> * tcp://<hostname>:<port> * tcp://localhost:<port>?listen=true& -- listen for connection on port. * tcp://localhost:<port>?listen=true&multiple=true -- listen for multiple Examples: * tcp://medea:12345 * tcp://localhost:12345?listen&handshake=3.8.12 Supported parameters: handshake :- specify a message that is matched with the other side listen :- open a server-socket for a client to connect to multiple :- leave server-socket open for more than 1 client to connect (listen must be set to true) nonblocking:- When listen is true, this will result in the call returning NULL if a client connection is not available immediately. It leaves the server socket open for client to connect.
Implements vtkNetworkAccessManager.
| virtual void vtkTCPNetworkAccessManager::AbortPendingConnection | ( | ) | [virtual] |
Used to abort pending connection creation, if any. Refer to NewConnection() for details.
Implements vtkNetworkAccessManager.
| virtual int vtkTCPNetworkAccessManager::ProcessEvents | ( | unsigned long | timeout_msecs | ) | [virtual] |
Process any network activity.
Implements vtkNetworkAccessManager.
| virtual bool vtkTCPNetworkAccessManager::GetNetworkEventsAvailable | ( | ) | [virtual] |
Peeks to check if any activity is available. When this call returns true, ProcessEvents() will always result in some activity processing if called afterword.
Implements vtkNetworkAccessManager.
| virtual bool vtkTCPNetworkAccessManager::GetPendingConnectionsPresent | ( | ) | [virtual] |
Returns true is the manager is currently waiting for any connections.
Implements vtkNetworkAccessManager.
| int vtkTCPNetworkAccessManager::ProcessEventsInternal | ( | unsigned long | timeout_msecs, |
| bool | do_processing | ||
| ) | [protected] |
| vtkMultiProcessController* vtkTCPNetworkAccessManager::ConnectToRemote | ( | const char * | hostname, |
| int | port, | ||
| const char * | handshake | ||
| ) | [protected] |
Connects to remote processes.
| vtkMultiProcessController* vtkTCPNetworkAccessManager::WaitForConnection | ( | int | port, |
| bool | once, | ||
| const char * | handshake, | ||
| bool | nonblocking | ||
| ) | [protected] |
Waits for connection from remote process.
| bool vtkTCPNetworkAccessManager::ParaViewHandshake | ( | vtkMultiProcessController * | controller, |
| bool | server_side, | ||
| const char * | handshake | ||
| ) | [protected] |
Member Data Documentation
bool vtkTCPNetworkAccessManager::AbortPendingConnectionFlag [protected] |
Definition at line 98 of file vtkTCPNetworkAccessManager.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkTCPNetworkAccessManager.h
