Heartbeat
Top  Previous  Next

Description

Returns or sets the heartbeat timeout for the camera, in milliseconds.


Syntax


[VB]
objActiveGige.Heartbeat [= Value]


[C/C++]
HRESULT get_Heartbeat( long *pValue );
HRESULT put_Heartbeat( long Value );



Data Type
[VB]

Long


Parameters
[C/C++]

pValue [out,retval]  
Pointer to the current heartbeat timeout of the camera.  
Value [in]  
The heartbeat timeout to be set. The minimum value is 500 ms.  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  
E_INVALIDARG  
Invalid property value.  
 

Example


This VB example sets the heartbeat timeout for the camera into 10 sec:

ActiveGige1.Heartbeat=10000
 

Remarks

The heartbeat mechanism allows a GigE Vision application to maintain its connection with the camera by periodically exchanging data with it. The heartbeat timeout indicates the maximum interval during which the camera will expect the primary application to send a data request. If the application remains inactive for the period larger than the heartbeat timeout, the camera will close its connection with the application and make itself available to other applications.

The Heartbeat property should not be confused with the Heartbeat setting available in the IP configuration utility. The latter one is provided for setting the rate at which ActiveGigE-based applications send heartbeat signals to all cameras, while the Heartbeat property sets the timeout period of the current camera by modifying/reading its heartbeat timeout register.

The default value of the heartbeat timeout for a typical GigE Vision camera is 3000 ms. Setting the heartbeat timeout to a large value is recommended for debugging a GigE Vision application. This will prevent the camera from closing its connection with the application during long periods of inactivity related to the debugging process.