Unsubscribe Method

Removes an existing subscription.

Syntax

ANSI (Cross Platform)
int Unsubscribe(const char* lpszId);

Unicode (Windows)
INT Unsubscribe(LPCWSTR lpszId);
- (void)unsubscribe:(NSString*)id;
#define MID_STOMP_UNSUBSCRIBE 16

IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_STOMP_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 C++ Edition - Version 20.0 [Build 8265]