Struct PntosMessage

Defined in File common.h

Struct Documentation

struct PntosMessage

A container for an ASPN message. This container may contain either proper ASPN messages which are part of the ASPN data model, or extension messages specific to pntOS which augment ASPN. For messages of the former type, the wrapped message’s message_type field should be used directly. For messages of the latter type, cast the wrapped message’s message_type field to PntosMessageType.

Invariants:

PntosMessage.source_identifier must be a pointer to an array of allocated memory ending in a \0 character

Public Members

PntosManagedMemory *memory

AspnBase *wrapped_message: Either an ASPN message or a pntOS ASPN Extension message, depending on the value of wrapped_message.message_type.

char *source_identifier: A \0 terminated C string. The string represents a source identifier indicating where this message came from. If the message originated from a transport plugin and the underlying transport has the concept of a channel or topic, this field should be populated by the channel or topic. Otherwise, the identifier is populated in a plugin-specific manner by the originating plugin that created the message.