Add contextual information to log messages. More...

Classes
class	ActivityContext
	Activity Context APIs. More...

class	ActivityContextAttributeKind
	The resources of the Activity Context can have multiple associated attributes. Those attributes provide extra information about the entity such as GUID prefix, Topic, data type, entity kind, entity name and domain ID. They are used to indicate what attributes of the resources are included in the activity context. More...

Functions
static void	set_attribute_mask (int attribute_mask)
	Set the com.rti.ndds.config.ActivityContextAttributeKindMask of the Activity Context. More...

Detailed Description

Add contextual information to log messages.

The Activity Context is a group of resources and activities associated with an action such as the creation of an entity.

A resource is a abstraction of an entity. It can contain attributes such as Topic or domain ID.
An activity is a general task that the resource is doing, such as "Getting QoS".

Logging context is one of the formats RTI Connext logging infrastructure supports. It is used by default in com.rti.ndds.config.LogPrintFormat.NDDS_CONFIG_LOG_PRINT_FORMAT_DEFAULT. It provides information about resources and activities. The activity context is used in two places:

Logging: activity context is one of the com.rti.ndds.config.LogPrintFormat DDS logging infrastructure supports. If that format is set every time RTI Connext logs a message, it will contain the contextual information.
Heap monitoring: every time memory is allocated and heap monitoring is enabled, the string representation of the activity context will be associated with the allocation. This information will be available when taking the snapshot.

For example, in the creation of a DataWriter, the activity context will provide information about:

Resource: the Publisher creating the DataWriter. Attributes of the publisher will be GUID, kind, name and domain ID.
Activity: entity creation. It will have two parameters, the entity kind and the Topic. In the example below, these are "Writer" and "TestTopic".

The string representation of the above activity context would be:

[0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000088{Entity=Pu,Name=TestPublisher,Domain=1}|CREATE Writer WITH TOPIC TestTopic]

Another example could be when a DataWriter writes a sample. The activity context will provide information about:

Resource: the DataWriter writing the sample. The attributes of the DataWriter will be GUID, name, kind, Topic, data type, and the domain ID.
Activity will be "write a sample".

The string representation of the activity context will be:

[0X101A76B,0X79E5D71,0X50EE914:0X1C1:0X80000003{Name=testDataWriterName,Entity=DW,Topic=test,Type=Foo,Domain=1}|Write]

Function Documentation

static void set_attribute_mask ( int attribute_mask )

static

Set the com.rti.ndds.config.ActivityContextAttributeKindMask of the Activity Context.