Unsubscribe Method

Removes an existing subscription.

Syntax

stomp.unsubscribe(id, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method removes an existing subscription identified by the given Id, unsubscribing the class from the destination associated with the subscription.

Once unsubscribed, the relevant item will be removed from the Subscription* properties and the Unsubscribed event will fire.

Basic Subscriptions Example

stomp1.OnMessageIn += (s, e) => {
  Console.WriteLine("Received message from destination '" + e.Destination + "':");
  Console.WriteLine(e.Data);
};

string subId = stomp1.Subscribe("test/a/b", false);
// Some time later...
stomp1.Unsubscribe(subId);