[TIBCO.EMS .NET Admin client library 6.0 documentation]

Compact one of the server's store files until either no more compaction can be done or timeout seconds have elapsed, whichever occurs first. (See remarks for important warning).

Namespace:  TIBCO.EMS.ADMIN
Assembly:  TIBCO.EMS.ADMIN (in TIBCO.EMS.ADMIN.dll)

Syntax

public bool Compact(
	string name,
	long timeout
)
Public Function Compact ( _
	name As String, _
	timeout As Long _
) As Boolean
public:
bool Compact(
	String^ name, 
	long long timeout
)

Parameters

name
Type: System..::.String
the store file 'name' to compact.
timeout
Type: System..::.Int64
time in seconds allowed for compaction (must be greater than zero).

Return Value

true if the store file was fully compacted before the timeout expired, false otherwise.

Remarks

WARNING: Once started, it is not possible to interrupt the compaction, and all other operations (creating new connections, sending and/or receiving messages, etc...) will be suspended during, at most, the number of seconds specified (the 'timeout' value).

Exceptions

ExceptionCondition
TIBCO.EMS.ADMIN..::.AdminExceptionif not authorized or an error occurred.
System..::.ArgumentException if store is invalid or timeout is not greater than zero.

See Also