ex/ios/intro/HelloWorldWebSubExample.m

/*
 *  This source is distributed under the terms and conditions
 *  of any contract or contracts between Solace and you or
 *  your company. If there are no contracts in place use of
 *  this source is not authorized. No support is provided and
 *  no distribution, sharing with others or re-use of this
 *  source is authorized unless specifically stated in the
 *  contracts referred to above.
 *
 *  Copyright 2012-2024 Solace Corporation. All rights reserved.
 */

#import "HelloWorldWebSubExample.h"

@implementation HelloWorldWebSubExample

@synthesize msgCount;

- (id)initWithExampleInterface:(ExampleInterface *)exampleInterface {
    self = [super initWithExampleInterface:exampleInterface];

    // Set example name and description
    self.name = @"HelloWorldWebSub";
    self.description = @"Demonstrates the basics of web messaging session "
        @"creation, connection and receiving a direct message from a topic";

    // Set up example parameters
    [self.parameters parameterWithId:PARAMETER_HOST].value =
        @"http://192.168.168.136";

    [self.parameters addParameter:PARAMETER_DESTINATION_TOPIC];
    [self.parameters addParameter:PARAMETER_WEB_PROTOCOL];

    [self.parameters removeParameter:PARAMETER_PASSWORD];
    [self.parameters removeParameter:PARAMETER_COMPRESSION];
    [self.parameters removeParameter:PARAMETER_LOGGING_LEVEL];

    return self;
}

- (solClient_rxMsgCallback_returnCode_t)
    messageReceiveCallbackWithSession:
        (solClient_opaqueSession_pt)opaqueSession_p
                              message:(solClient_opaqueMsg_pt)msg_p
                             userData:(void *)user_p {
    // The message callback is invoked for each direct message received by the
    // session. In this sample, the message is printed to the screen.
    solClient_log(SOLCLIENT_LOG_NOTICE, "Received message:\n");
    char buffer[5000];
    solClient_msg_dump(msg_p, buffer, 5000);
    solClient_log(SOLCLIENT_LOG_NOTICE, buffer);

    self.msgCount++;

    return SOLCLIENT_CALLBACK_OK;
}

- (void)eventCallbackWithSession:(solClient_opaqueSession_pt)opaqueSession_p
                       eventInfo:
                           (solClient_session_eventCallbackInfo_pt)eventInfo_p
                        userData:(void *)user_p {
    // The use of an empty function is necessary as the event callback function
    // is mandatory for session creation.
}

- (void)run {
    [super run];

    // Context variables
    solClient_opaqueContext_pt context_p;
    solClient_context_createFuncInfo_t contextFuncInfo =
        SOLCLIENT_CONTEXT_CREATEFUNC_INITIALIZER;

    // Session variables
    solClient_opaqueSession_pt session_p;
    solClient_session_createFuncInfo_t sessionFuncInfo =
        SOLCLIENT_SESSION_CREATEFUNC_INITIALIZER;

    // Session properties
    const char *sessionProps[20];
    int propIndex = 0;

    self.msgCount = 0;

    // Ensure HTTP and WS protocols are being used
    if (![[[[self.parameters parameterWithId:PARAMETER_HOST].value
            substringToIndex:4] lowercaseString] isEqualToString:@"http"] &&
        ![[[[self.parameters parameterWithId:PARAMETER_HOST].value
            substringToIndex:4] lowercaseString] isEqualToString:@"ws"]) {
        solClient_log(
            SOLCLIENT_LOG_ERROR,
            "This sample supports HTTP or WS transport protocols only.");
    }

    // Initialize the API; this must be done prior to first usage
    solClient_initialize(SOLCLIENT_LOG_DEFAULT_FILTER, NULL);

    solClient_log(SOLCLIENT_LOG_NOTICE, "HelloWorldWebSub initializing...\n");

    // Create a context, and specify that the context thread be created
    // automatically instead of having the application create its own
    // context thread.
    solClient_context_create(SOLCLIENT_CONTEXT_PROPS_DEFAULT_WITH_CREATE_THREAD,
                             &context_p, &contextFuncInfo,
                             sizeof(contextFuncInfo));

    // Message receive callback function and the Session event function
    // are both mandatory. In this sample, default functions are used.
    sessionFuncInfo.rxMsgInfo.callback_p = messageReceiveCallback;
    sessionFuncInfo.rxMsgInfo.user_p = self.nullBridge_p;
    sessionFuncInfo.eventInfo.callback_p = eventCallback;
    sessionFuncInfo.eventInfo.user_p = self.nullBridge_p;

    // Configure the session's properties
    propIndex = 0;

    sessionProps[propIndex++] = SOLCLIENT_SESSION_PROP_HOST;
    sessionProps[propIndex++] =
        [[self.parameters parameterWithId:PARAMETER_HOST].value
            cStringUsingEncoding:NSASCIIStringEncoding];

    sessionProps[propIndex++] = SOLCLIENT_SESSION_PROP_VPN_NAME;
    sessionProps[propIndex++] =
        [[self.parameters parameterWithId:PARAMETER_VPN].value
            cStringUsingEncoding:NSASCIIStringEncoding];

    sessionProps[propIndex++] = SOLCLIENT_SESSION_PROP_USERNAME;
    sessionProps[propIndex++] =
        [[self.parameters parameterWithId:PARAMETER_USERNAME].value
            cStringUsingEncoding:NSASCIIStringEncoding];

    if (![[self.parameters parameterWithId:PARAMETER_WEB_PROTOCOL].value
            isEqualToString:@""]) {
        sessionProps[propIndex++] =
            SOLCLIENT_SESSION_PROP_WEB_TRANSPORT_PROTOCOL_LIST;
        sessionProps[propIndex++] =
            [[self.parameters parameterWithId:PARAMETER_WEB_PROTOCOL].value
                cStringUsingEncoding:NSASCIIStringEncoding];
    }

    sessionProps[propIndex] = NULL;

    // Create the session
    solClient_session_create((char **)sessionProps, context_p, &session_p,
                             &sessionFuncInfo, sizeof(sessionFuncInfo));

    // Connect the session
    solClient_session_connect(session_p);
    solClient_log(SOLCLIENT_LOG_NOTICE, "Connected.\n");

    solClient_session_topicSubscribeExt(
        session_p, SOLCLIENT_SUBSCRIBE_FLAGS_WAITFORCONFIRM,
        [[self.parameters parameterWithId:PARAMETER_DESTINATION_TOPIC].value
            cStringUsingEncoding:NSASCIIStringEncoding]);

    solClient_log(SOLCLIENT_LOG_NOTICE, "Waiting for message......\n");
    while (self.msgCount < 1 &&
           !self.requestCancel) {
        [NSThread sleepForTimeInterval:1];
    }

    solClient_log(SOLCLIENT_LOG_NOTICE, "Exiting.\n");

    solClient_session_topicUnsubscribeExt(
        session_p, SOLCLIENT_SUBSCRIBE_FLAGS_WAITFORCONFIRM,
        [[self.parameters parameterWithId:PARAMETER_DESTINATION_TOPIC].value
            cStringUsingEncoding:NSASCIIStringEncoding]);

    // Cleanup solclient
    solClient_cleanup();

    [self cleanup];
}

@end