OpenDOF Project
Files | Macros | Typedefs | Functions
DOSOperation
OpenDOF Stack (DOS)

Files

file  cos.h
 Header file for the COS functions, defines and data types.
 

Macros

#define DOSOPERATION_HEURISTIC_ALL
 Operation heuristic value indicating all nodes should execute and respond.
 
#define DOSOPERATION_HEURISTIC_NONE
 Operation heuristic value indicating no nodes should execute or respond.
 
#define DOSOPERATIONRESPONSELEVEL_ALL
 All: All responses, including non-final (intermediate) Provider exceptions.
 
#define DOSOPERATIONRESPONSELEVEL_EXCEPTION
 Exception: All internal and final Provider exceptions, in addition to successful responses.
 
#define DOSOPERATIONRESPONSELEVEL_NONE
 None: No responses (silent).
 
#define DOSOPERATIONRESPONSELEVEL_SUCCESS
 Success: Successful responses only (no exceptions).
 

Typedefs

typedef uint16 DOSOperationResponseLevel
 Response Level constants can be used by the user to set desired response level for request operations.
 

Functions

DOSOperationCount DOSOperation_GetCount (const DOSOperation op)
 Return the operation count for the operation.
 
uint16 DOSOperation_GetHeuristic (DOSOperation op)
 Get the heuristic previously set on an operation.
 
DOSOperationResponseLevel DOSOperation_GetResponseLevel (DOSOperation op)
 Get the response level of a request operation.
 
uint8 DOSOperation_GetRetryCount (DOSOperation op)
 Gets the number of times that the given operation has been retried.
 
DOSTimeout DOSOperation_GetTimeout (const DOSOperation op)
 Get the time remaining for an operation.
 
void DOSOperation_IncrementRetryCounter (DOSOperation op)
 Increment the retry counter in an operation.
 
int DOSOperation_IsAcked (DOSOperation op)
 Returns if a given operation has been acknowledge.
 
boolean DOSOperation_IsDelay (DOSOperation op)
 Determine if an operation has delay behavior enabled or disabled.
 
boolean DOSOperation_IsExplicit (DOSOperation op)
 Determine if an operation will use an explicit or implicit Source ID.
 
void DOSOperation_Remove (DOSOperation op)
 Remove a previously saved operation.
 
DOSOperation DOSOperation_Save (void)
 Save an operation (local or remote).
 
DOSOperation DOSOperation_Save_Register (DOSEvent *event)
 Save a register request on the provider side.
 
DOSOperation DOSOperation_Save_Subscribe (DOSProperty *property)
 Save a subscription request on the provider side.
 
void DOSOperation_SetDelay (DOSOperation op, boolean isDelay)
 Set whether or not an operation will cause responses to be randomly distributed across the operation's lifetime.
 
void DOSOperation_SetExplicit (DOSOperation op, boolean isExplicit)
 Set whether or not an operation will use an explicit Source ID.
 
void DOSOperation_SetHeuristic (DOSOperation op, uint16 heuristic)
 Enable randomized acceptance of the operation.
 
void DOSOperation_SetResponseLevel (DOSOperation op, DOSOperationResponseLevel level)
 Set the response level of a request operation.
 
void DOSOperation_SetTimeout (DOSOperation op, DOSTimeout delay)
 Set the time remaining for an operation.
 

Detailed Description

core-c-cos Version 7.0.1 Build 0
2018-02-08