Receiver Members
Microsoft Robotics Class Reference
The Receiver type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Receiver(IPortReceive, ITask) |
Constructs a SingleItemReceiver
|
|
Receiver(Boolean, IPortReceive, ITask) |
Constructs a SingleItemReceiver
|
Methods
| Name | Description | |
|---|---|---|
|
Cleanup() () () () |
Unregisters this receiver instance from the port
(Overrides ReceiverTask. . :: . .Cleanup() () () ().) |
|
Cleanup(ITask) |
Post back any message instances associated with the Task instance
(Overrides ReceiverTask. . :: . .Cleanup(ITask).) |
|
Consume |
Consume
(Overrides ReceiverTask. . :: . .Consume(IPortElement).) |
|
Equals | (Inherited from Object.) |
|
Evaluate |
Invoked in the context Port.Post(). The receiver will consult its parent arbiter and if the parent accepts, the receiver will consume the item, and schedule a task with it as an argument
(Overrides ReceiverTask. . :: . .Evaluate(IPortElement, ITask%).) |
|
Execute |
Invoked by the scheduler to register the receiver on the ports.
(Inherited from ReceiverTask.) |
.gif "Protected method") |
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
|
GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
|
MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
|
PartialClone |
Shallow clone of receiver state and task state
(Inherited from ReceiverTask.) |
|
ToString |
Human readabable description of receiver type, associated handler, nesting hierarchy and state
(Inherited from ReceiverTask.) |
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Arbiter |
Parent arbiter to consult before consuming a message
(Overrides ReceiverTask. . :: . .Arbiter.) |
|
ArbiterCleanupHandler |
Set by a top level arbiter so it can execute logic on task completion
(Inherited from TaskCommon.) |
|
ArbiterContext |
Used by parent arbiter to store context
(Inherited from ReceiverTask.) |
|
Item |
Returns the arguments contained in the receiver
(Inherited from ReceiverTask.) |
|
LinkedIterator |
Iterator that needs to be processed once current task completes
(Inherited from TaskCommon.) |
|
PortElementCount |
Number of arguments this receiver is waiting on
(Inherited from ReceiverTask.) |
|
State |
Receiver state
(Inherited from ReceiverTask.) |
|
TaskQueue |
Dispatcher queue to use for scheduling any tasks
(Inherited from TaskCommon.) |
.gif "Protected property") |
UserTask |
Task instance that contains the user delegate plus arguments.
(Inherited from ReceiverTask.) |