TipcSrvSubjectSetSubscribeEx

Name

TipcSrvSubjectSetSubscribeEx — start or stop subscribing to a subject using extended options

Synopsis

T_BOOL TipcSrvSubjectSetSubscribeEx(subj_name, status, type, flags, 
type_specific_struct) 
T_STR subj_name; 
T_BOOL status; 
T_INT4 type; 
T_INT4 flags; 
T_PTR type_specific_struct;

Arguments

subj_name — name of the subject to set subscribe status for

status — subscribe status (TRUE to subscribe or FALSE to unsubscribe)

type — type of subscribe to use (T_SUBJ_NONE for a normal subscribe or T_SUBJ_CACHE to enable the SmartSockets Cache interface)

flags — describe the attribute of type

type_specific_struct — used to pass any additional information needed by a type

Return Values

TRUE if the subscribe status of the subject was successfully set, FALSE otherwise.

Diagnostics

If TipcSrvSubjectSetSubscribeEx fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_DOESNT_EXIST — type was T_SUBJ_CACHE and caching options were not found, usually because caching was not initialized. See the TIBCO SmartSockets Cache User’s Guide for more information.

any error number from TipcSrvSubjectSetSubscribe.

Description

TipcSrvSubjectSetSubscribeEx is used to subscribe to a subject using extended options. Currently the only option available is caching.

If type is T_SUBJ_NONE, flags must be set to zero (0).

If type is T_SUBJ_CACHE, flags must be one of:

T_SUBJ_FLAG_SC_INITIAL_LOAD — for force initial load

T_SUBJ_FLAG_SC_LATEST_MSG — to retrieve the last message from the cache or a new message if one arrives before the cache retrieval has completed

If type is either T_SUBJ_NONE or T_SUBJ_CACHE, type_specific_struct must be set to T_NULL.

Caution

None

Examples

This example retrieves a message from SmartSockets Cache:

/* Retrieve message from Cache */ 
TutOut("Retrieving messages from Cache ...\n"); 
 
TipcSrvSubjectSetSubscribeEx( 
  "/SCache/*",                  /* requested subject */ 
  T_TRUE,                       /* true to subscribe */ 
  T_SUBJ_CACHE,                 /* type of subscribe */ 
  T_SUBJ_FLAG_SC_INITIAL_LOAD,  /* attribute type to last value */ 
  T_NULL);                      /* as using T_SUBJ_CACHE */