Share via


message Class

The basic message envelope containing the data payload being passed between messaging blocks.

template<
   class _Type
>
class message : public ::Concurrency::details::_Runtime_object;

Parameters

  • _Type
    The data type of the payload within the message.

Members

Public Typedefs

Name

Description

type

A type alias for _Type.

Public Constructors

Name

Description

message::message Constructor

Overloaded. Constructs a message object.

message::~message Destructor

Destroys the message object.

Public Methods

Name

Description

message::add_ref Method

Adds to the reference count for the message object. Used for message blocks that need reference counting to determine message lifetimes.

message::msg_id Method

Returns the ID of the message object.

message::remove_ref Method

Subtracts from the reference count for the message object. Used for message blocks that need reference counting to determine message lifetimes.

Public Data Members

Name

Description

message::payload Data Member

The payload of the message object.

Remarks

For more information, see Asynchronous Message Blocks.

Inheritance Hierarchy

message

Requirements

Header: agents.h

Namespace: concurrency

See Also

Reference

concurrency Namespace