VDSF
Menu

vdsProcess Class Reference

List of all members.

Public Member Functions

 vdsProcess ()
void Init (const char *wdAddress, bool protectionNeeded=false)
 This function initializes access to a VDS.
virtual ~vdsProcess ()
 The destructor terminates all access to the VDS.

Constructor & Destructor Documentation

vdsProcess::vdsProcess (  ) 

virtual vdsProcess::~vdsProcess (  )  [virtual]

The destructor terminates all access to the VDS.

This function will also close all sessions and terminate all accesses to the different objects.


Member Function Documentation

void vdsProcess::Init ( const char *  wdAddress,
bool  protectionNeeded = false 
)

This function initializes access to a VDS.

It takes 2 input arguments, the address of the watchdog and a boolean value. This last one indicates if sessions and other objects (Queues, etc) are shared amongst threads (in the current process) and must be protected. Recommendation: always set protectionNeeded to false unless you cannot do otherwise. In other words it is recommended to use one session object for each thread. Also if the same queue needs to be accessed by two threads it is more efficient to have two different objects instead of sharing a single one.

[Additional note: API objects (or C handles) are just proxies for the real objects sitting in shared memory. Proper synchronization is already done in shared memory and it is best to avoid to synchronize these proxy objects.]

Parameters:
[in] wdAddress The address of the watchdog. Currently a string with the port number ("12345").
[in] protectionNeeded A boolean value indicating if multi-threaded locks are needed or not.
Exceptions:
vdsException An abnormal error occured.


The documentation for this class was generated from the following file:

Last updated on March 23, 2008.