TipcMonSubjectNamesGetWatch

Name

TipcMonSubjectNamesGetWatch — determine if this RTclient is watching subject names

Synopsis

T_BOOL TipcMonSubjectNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return;

Arguments

watch_status_return — storage for watch status

Return Values

TRUE if the subject names watch status was successfully retrieved, FALSE otherwise.

Diagnostics

If TipcMonSubjectNamesGetWatch fails, it returns FALSE and sets the global SmartSockets error number to:

T_ERR_NULL_PTR — watch_status_return was null

Description

TipcMonSubjectNamesGetWatch gets whether this RTclient is watching the subject names in the current project that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_SUBJECT_NAMES_STATUS message each time a subject is created or destroyed. A subject is considered created when the first RTclient starts subscribing to that subject. A subject is considered destroyed when the last RTclient stops subscribing to that subject.

Each MON_SUBJECT_NAMES_STATUS message contains three fields:

a STR_ARRAY field containing the current subject names

a STR field containing the name of the created subject ("" if not applicable)

a STR field containing the name of the destroyed subject ("" if not applicable)

Use TipcMonSubjectNamesSetWatch to set whether this RTclient is watching subject names. To poll once for subject names, use TipcMonSubjectNamesPoll.

Caution

If TipcMonSubjectNamesGetWatch returns FALSE, it does not store a value in watch_status_return.

Examples

This uses TipcMonSubjectNamesGetWatch to get the status of watching subject names:

T_BOOL watch_status; 
if (!TipcMonSubjectNamesGetWatch(&watch_status)) { 
  return; /* error */ 
} 
TutOut("This process is %s subject names.\n", 
       watch_status ? "watching" : "not watching");