PLActorMessage Class Reference

A reusable base class for messaging. More...

Inheritance diagram for PLActorMessage:

[legend]

List of all members.

Public Member Functions
(id)	- init
	Initialize with a nil object payload.
(id)	- initWithObject:
	Initialize with the given object payload.
(id)	- initWithObject:transactionId:
	Initialize with the given object payload and transaction id.
(id< PLActorProcess >)	- sender
	Return the message sender.
(id)	- object
	Return the message contents.
(PLActorTxId)	- transactionId
	Return the message transaction ID.
Static Public Member Functions
(id)	+ message
	Create a new message with a nil object payload.
(id)	+ messageWithObject:
	Create a new message with the given object payload.
(id)	+ messageWithObject:transactionId:
	Create a new message with the given object payload and transaction id.

---

Detailed Description

A reusable base class for messaging.

While ActorKit supports messaging with any object, the PLActorMessage class provides generally useful facilities such as unique transaction Ids, automatically determining the message sender, and including message payloads.

---

Member Function Documentation

+ (id) message

Create a new message with a nil object payload.

The message sender will be set to the current process, and the transaction ID will be set using ActorKit::createTransactionId.

+ (id) messageWithObject:

(id)

object

Create a new message with the given object payload.

The message sender will be set to the current process, and the transaction ID will be set using ActorKit::createTransactionId.

Parameters:

object

Message payload.

+ (id) messageWithObject:		(id)	object
transactionId:		(PLActorTxId)	transactionId

Create a new message with the given object payload and transaction id.

The message sender will be set to the current process

Parameters:

	object	Message payload.
	transactionId	Caller defined message transaction ID.

- (id) init

Initialize with a nil object payload.

The message sender will be set to the current process, and the transaction ID will be set using ActorKit::createTransactionId.

- (id) initWithObject:

(id)

object

Initialize with the given object payload.

The message sender will be set to the current process, and the transaction ID will be set using ActorKit::createTransactionId.

Parameters:

object

Message payload.

- (id) initWithObject:		(id)	object
transactionId:		(PLActorTxId)	transactionId

Initialize with the given object payload and transaction id.

The message sender will be set to the current process

Parameters:

	object	Message payload.
	transactionId	Caller defined message transaction ID.

---

The documentation for this class was generated from the following files:

• Source/PLActorMessage.h
• Source/PLActorMessage.m