OpenDOF Project
Files | Functions
DOFState
DOF

A DOFState instance represents a snapshot of the DOF's configuration information as it exists at the moment when you call DOF_CreateState. More...

Files

file  oal.h
 Header file for the C OAL functions, defines and data types.
 

Functions

void DOFState_Destroy (DOFState self)
 Destroys the DOFState.
 
DOFObjectIDSource DOFState_GetSourceID (DOFState self)
 Gets the identifier that is used for the DOF's operations in the unsecured domain.
 
uint32 DOFState_GetMaxOperations (DOFState self)
 Gets the maximum number of operations, including both local and remote operations, that a DOF supports.
 
uint16 DOFState_GetMaxConnections (DOFState self)
 Gets the maximum number of connections, both inbound and outbound, that a DOF currently supports.
 
uint32 DOFState_GetConnectionLimit (DOFState self)
 Gets the maximum number of connections, both inbound and outbound, that a DOF currently supports.
 
uint16 DOFState_GetThreadPoolSize (DOFState self)
 Gets the maximum number of threads that the DOF can create to process requests.
 
boolean DOFState_IsRouter (DOFState self)
 Discovers whether a DOF is configured as a router.
 
uint8 DOFState_GetRank (DOFState self)
 Gets the node's rank, which represents its desire to manage a secure multicast group.
 
boolean DOFState_IsParameterValidation (DOFState self)
 Checks whether the DOF validates DOFValue objects to verify that the associated DOFType matches a required type.
 

Detailed Description

A DOFState instance represents a snapshot of the DOF's configuration information as it exists at the moment when you call DOF_CreateState.

After calling DOF_CreateState, use the DOFState functions to retrieve specific information about the DOF's configuration. Because the DOF's configuration information may change, you should call DOF_CreateState again each time you want updated information.

core-c-dof-oal Version 7.1.5 Build 0
2017-01-25