OpenDOF Project
boolean DOF_SetNodeDown ( DOF  self)

Notifies the network that a DOF is about to be destroyed.

It is beneficial for network efficiency to notify other nodes before destroying a DOF, because it prevents state associated with the DOF's operations on other nodes from entering a source-lost state, thereby preventing network communication related to attempts to recover the lost resources. This function should be called only before destroying components and using the DOF_Destroy function. Continuing to send DOF operations to the rest of the network after sending a DOF_SetNodeDown call will cause your DOF's state to be out of synch with other nodes and may result in unpredictable behavior.

You should always call DOF_SetNodeDown at the beginning of application cleanup for a DOF. You should not call DOF_SetNodeDown before destroying any other components unless you intend to also destroy the DOF. DOF_SetNodeDown does not replace DOF_Destroy. You must still call DOF_Destroy after calling DOF_SetNodeDown. DOF_SetNodeDown does not operate as a way to stop the DOF temporarily. The DOF cannot be restarted after making this call. DOF_SetNodeDown will set the connection limit for the DOF to zero so that no new inbound or outbound connections will be allowed to connect.

Parameters
selfThe DOF instance that is about to be destroyed. This must not be NULL.
Return values
TRUEif the node was set down.
Exceptions
FALSEis returned if the function fails to set the node down.
core-c-dof-oal Version 8.0.1 Build 0
2018-01-22