BrokerClient.Flush Method (Int32)

Informs the broker that it should commit all request messages, subject to the specified timeout period.


Namespace: Microsoft.Hpc.Scheduler.Session
Assembly: Microsoft.Hpc.Scheduler.Session (in Microsoft.Hpc.Scheduler.Session.dll)

'Usage
Dim instance As BrokerClient(Of TContract)
Dim timeoutMilliseconds As Integer

instance.Flush(timeoutMilliseconds)

public void Flush (
	int timeoutMilliseconds
)
public void Flush (
	int timeoutMilliseconds
)
public function Flush (
	timeoutMilliseconds : int
)

Parameters

timeoutMilliseconds

Integer that specifies the length of time in milliseconds that the method should wait for the broker to commit the request messages.

Exception typeCondition
System.TimeoutException

The broker did not commit the request messages within the specified timeout period.

To use the default timeout period of 60,000 milliseconds, use the Flush method instead.

noteNote
The difference between the Flush(Int32) method and the EndRequests(Int32) method: The Flush(Int32) method commits all pending request messages, and allows further request messages to be sent after the Flush(Int32) method was called. The EndRequests(Int32) method commits all pending request messages, and does not allow further request messages to be sent.

Platform Note: This method was introduced in Windows HPC Server 2008 R2 with Service Pack 1 (SP1) and is not supported in previous versions.


No members of this type are thread safe.

Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, with HPC Pack Client Utilities




Build Date:

2013-04-22
Show: