BrokerClient.Close Method (Boolean, Int32)

Closes the connection to the broker, and optionally empties and deletes the message queues that correspond to the BrokerClient object that is 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 purge As Boolean
Dim timeoutMilliseconds As Integer

instance.Close(purge, timeoutMilliseconds)

public void Close (
	bool purge,
	int timeoutMilliseconds
)
public void Close (
	boolean purge, 
	int timeoutMilliseconds
)
public function Close (
	purge : boolean, 
	timeoutMilliseconds : int
)

Parameters

purge

A Boolean object that specifies whether to empty and delete the message queues that correspond to the BrokerClient object. True indicates that the method should empty and delete the message queues. False indicates that the method should not empty and delete the message queues.

timeoutMilliseconds

Specifies the length of time in milliseconds that the method should wait for the message queues to be emptied and deleted.

Platform Note: This method was introduced in Windows HPC Server 2008 R2 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: