10.27.03

ICacheSessionCancelCacheRequests Method

Cancel all in progress cache requests for a given cache session. This function is thread safe and can be called from any thread. When this function is invoked:
  • All blocked synchronous cache requests will return immediately with SOLCLIENT_INCOMPLETE return code and CacheRequestCancelled subcode.
  • A cache event RequestCompletedNotice with a subcode of CacheRequestCancelled is generated for each in progress asynchronous cache request.
  • The associated cache session is still valid to use.
  • Live messages that have been queued (if any) will be delivered.

    • Definition

    Namespace: SolaceSystems.Solclient.Messaging.Cache
    Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.27.0
    C#
    ReturnCode CancelCacheRequests()

    Return Value

    ReturnCode
    SOLCLIENT_OK, if successful, otherwise an exception is thrown

    Exceptions

    OperationErrorException Thrown when the operation fails, see ErrorInfo for specific failure reason.
    ObjectDisposedException Thrown when the session is already disposed (terminal state).
    FatalErrorException Thrown when an unrecoverable error occurs.

    See Also