BrokerClient.Close Method (Boolean)

Closes the connection to the broker, and optionally empties and deletes the message queues that correspond to the BrokerClient object.


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

instance.Close(purge)

public void Close (
	bool purge
)
public void Close (
	boolean purge
)
public function Close (
	purge : boolean
)

Parameters

purge

Boolean 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.

Calling this method with the purge parameter set to false is equivalent to calling the Close method.

The default timeout period for the emptying and deleting the message queues is 60,000 milliseconds. To specify the length of the timeout period, use Close(Boolean,Int32) instead.

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: