FabricRequest.cs - Appistry EAF v3.8

Namespace: Appistry.FabricAPI

Class FabricRequest

Implements

FabricRequest implements IDictionary

In code, access the IDictionary interface of FabricRequest like any other dictionary. For example, in C# you use brackets to set or get name/value pairs...

float celcuis=system.Convert.ToString(request["celsius"]);
float fahrenheit=((9f/5f) * celsius) + 32f;
request ["fahrenheit"]=fahrenheit.ToString( );

...and in Visual Basic you do not. For example,

str=request.Item("somestring")
request.Item("somestring")=str.ToUpper( )

Properties

string this[string key]	This property is an indexer that reads and writes attributes to a request in the form of key/value pairs. The set and get accessors are available for this property.
string ApplicationName	This property specifies the desired application. When setting this property, verify the application name is identical to the application name element in application .xml file name. The get accessor returns the application name. The set accessor may throw a NullReferenceException.
string ProcessFlowName	This property specifies the desired process flow. When setting this property, verify the process flow name is identical to the process flow name element in the process flow .xml file. The get accessor returns the process flow name. The set accessor may throw a NullReferenceException.
string Username	This property specifies the user name. The set and get accessors are available for this property. The set accessor may throw a NullReferenceException.
string Password	This property specifies the user's password. Only the setaccessor is available for this property. The set accessor may throw aNullReferenceException.
int ProcessingTimeout	This property specifies the maximum amount of time, in seconds, the application fabric waits to receive the response to a request. A value of -1, the default setting, indicates infinite. The set and get accessors are available for this property.
int SetupTimeout	This property specifies the maximum amount of time, in milliseconds, the client and the application fabric attempts to locate a worker for request processing. A value of -1, the default setting, indicates infinite. The set and get accessors are available for this property.
int RecoverTimeout	This property specifies the maximum amount of time, in seconds, a client and the application fabric attempt to retrieve the results of a process lost within the application fabric. The default value is 60 seconds. The set and get accessors are available for this property.
string Result	This property returns the result value of the process flow. This is the value returned from the fabric application as set by the last task in the process flow definition file. Only the get accessor is available for this property.
string Id	This property creates an identifier for a request that is unique across the entire application fabric. The application fabric uses the request identifier when performing a request recovery. The set and get accessors are available for this property. You may generate your own request identifier; however, you must ensure the request identifier is unique across the entire application fabric. If two requests are submitted to the application fabric with the same request identifier and both requests require recovery, you will be unable to determine to which request the result applies.
int SetupRetries	This property specifies the number of times the fabric attempts to retry locating workers for request processing. The set and get accessors are available for the property.
bool AutoRecover	This property specifies whether or not the fabric automatically attempts to recover the specified process lost within the fabric. The set and get accessors are available for this property.
Exception LastException	This property returns the last .NET exception to occur in the fabric for this request.

Methods

FabricRequest

This is the class constructor. Appistry recommends using the dispose method to free unmanaged resources allocated for this request. Waiting for the .NET garbage collect to clean up the object may result in large memory utilization by the client application.

FabricRequest(string applicationName,
              string processFlowName)

string	application name
string	process flow name

or

FabricRequest(string applicationName,
              string processFlowName,
              IDictionary dictionary)

string	application name
string	process flow name
IDictionary	string keys and object values to be set into the FabricRequest dictionary

AddDictionary

void AddDictionary(IDictionary dictionary)

This method copies into the task request string keys and string values from a native .NET collection that implements IDictionary.

IDictionary	string keys and string values

Exceptions	NullReferenceException ArgumentException