DOFRequest

Represents a Request made to a Provider. More...

Typedefs
typedef struct DOFRequest_t *	DOFRequest
	Represents a request from another node in the DOF network, and contains a place to store error information for the Provider callbacks.

Functions
void	DOFRequestInvoke_Return (DOFRequest request, uint16 valuesCount, const DOFValue values[])
	Return a DOFValue list result to a requestor.
void	DOFRequestGet_Return (DOFRequest request, DOFValue value)
	Return a DOFValue result to a requestor.
boolean	DOFRequestGet_IsSubscribe (DOFRequest request)
	Return whether or not this request is the result of subscription activity.
void	DOFRequestSet_Return (DOFRequest request)
	Return a successful result (without any values) to a requestor.
void	DOFRequestSubscribe_Return (DOFRequest request)
	Accepts the subscription request.
void	DOFRequestRegister_Return (DOFRequest request)
	Accepts the registration request.
void	DOFRequestSession_Return (DOFRequest request)
	Accepts the session request.
boolean	DOFRequestSession_SetDataTransform (DOFRequest request, DOFOperationSessionDataTransform transform)
	Set the DOFOperationSessionDataTransform to use on this session.
DOFRequestType	DOFRequest_GetRequestType (const DOFRequest request)
	Get the connection type code of the request.
DOFObjectIDSource	DOFRequest_GetRequestorID (const DOFRequest request)
	Get the requestor Object ID for the request.
DOFAddress	DOFRequest_GetRequestorAddress (const DOFRequest request)
	Get the requestor's address.
DOFConnectionState	DOFRequest_GetConnectionState (const DOFRequest request)
	Retrieve the associated DOFConnectionState for the given DOFRequest.
DOFSecurityScope	DOFRequest_GetSecurityScope (const DOFRequest request)
	Retrieve the associated DOFSecurityScope for the given DOFRequest.
void	DOFRequest_Throw (DOFRequest request, DOFException except)
	Throw a DOFException to the Requestor and complete the request.
uint32	DOFRequest_GetTimeRemaining (DOFRequest request)
	Returns the time remaining of the request, in milliseconds.

Detailed Description

Represents a Request made to a Provider.

Also contains an "exception" status result the provider may wish to pass back to the Requestor.