solClient_session_eventCallbackInfo Struct Reference

A structure that is returned (as a pointer) for each event in the event callback for a Session. More...

#include <solClient.h>

Data Fields
solClient_session_event_t	sessionEvent
	The Session event that has occurred. More...
solClient_session_responseCode_t	responseCode
	A response code that is returned for some events, otherwise zero. More...
const char *	info_p
	Except for SOLCLIENT_SESSION_EVENT_ACKNOWLEDGEMENT (see Detailed Description above), a pointer to a NULL-terminated string providing further information about the event, when available. More...
void *	correlation_p
	Application-supplied correlation pointer where applicable. More...

Detailed Description

A structure that is returned (as a pointer) for each event in the event callback for a Session.

A structure is used so that new fields can be added in the future without affecting existing applications. For a sessionEvent of SOLCLIENT_SESSION_EVENT_ACKNOWLEDGEMENT, info_p will be the pointer or value set by solClient_msg_setCorrelationTag() or solClient_msg_setCorrelationTagPtr() in the message that is being acknowledged. This is used to correlate a published message to the acknowledgment received from the broker. In all other events info_p is a pointer to a NULL-terminated string.

Examples:

ex/adPubAck.c, ex/common.c, ex/common.h, ex/ios/EventCallbackProtocol.h, ex/ios/Example.m, ex/ios/examples/AppReachabilityExample.m, ex/ios/intro/HelloWorldPubExample.m, ex/ios/intro/HelloWorldSubExample.m, ex/ios/intro/HelloWorldWebPubExample.m, ex/ios/intro/HelloWorldWebSubExample.m, ex/replication.c, Intro/HelloWorldPub.c, Intro/HelloWorldQueuePub.c, Intro/HelloWorldQueueSub.c, Intro/HelloWorldSub.c, Intro/HelloWorldWebPub.c, and Intro/HelloWorldWebSub.c.

Field Documentation

void* correlation_p

Application-supplied correlation pointer where applicable.

Used when acknowledging or rejecting Guaranteed messages, in responses to any function calls that pass a correlationTag that will be returned in a Session Event.

Examples:

ex/adPubAck.c.

const char* info_p

Except for SOLCLIENT_SESSION_EVENT_ACKNOWLEDGEMENT (see Detailed Description above), a pointer to a NULL-terminated string providing further information about the event, when available.

This pointer is never NULL

Examples:

ex/replication.c.

solClient_session_responseCode_t responseCode

A response code that is returned for some events, otherwise zero.

solClient_session_event_t sessionEvent

The Session event that has occurred.

Examples:

ex/adPubAck.c, ex/common.c, ex/ios/Example.m, ex/ios/examples/AppReachabilityExample.m, ex/replication.c, and Intro/HelloWorldQueuePub.c.