message Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

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

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

Parameters

T
The data type of the payload within the message.

Public Typedefs

NameDescription
typeA type alias for T.

Public Constructors

NameDescription
message::message ConstructorOverloaded. Constructs a message object.
message::~message DestructorDestroys the message object.

Public Methods

NameDescription
message::add_ref MethodAdds to the reference count for the message object. Used for message blocks that need reference counting to determine message lifetimes.
message::msg_id MethodReturns the ID of the message object.
message::remove_ref MethodSubtracts from the reference count for the message object. Used for message blocks that need reference counting to determine message lifetimes.

Public Data Members

NameDescription
message::payload Data MemberThe payload of the message object.

For more information, see Asynchronous Message Blocks.

message

Header: agents.h

Namespace: concurrency

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

long add_ref();

Return Value

The new value of the reference count.

Constructs a message object.

message(
    T const& _P);

message(
    T const& _P,
    runtime_object_identity _Id);

message(
    message const& _Msg);

message(
    _In_ message const* _Msg);

Parameters

_P
The payload of this message.

_Id
The unique ID of this message.

_Msg
A reference or pointer to a message object.

Remarks

The constructor that takes a pointer to a message object as an argument throws an invalid_argument exception if the parameter _Msg is NULL.

Destroys the message object.

virtual ~message();

Returns the ID of the message object.

runtime_object_identity msg_id() const;

Return Value

The runtime_object_identity of the message object.

The payload of the message object.

T const payload;

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

long remove_ref();

Return Value

The new value of the reference count.

concurrency Namespace

Show: