Share via

JoinReceiver Members

  • Article

Microsoft Robotics Class Reference

The JoinReceiver type exposes the following members.

Constructors

  Name Description
Public method JoinReceiver
Constructs a Join Receiver, an arbiter that waits for one message per port in any order

Methods

  Name Description
Protected method Arbitrate
Determines if join commit can proceed
(Inherited from JoinReceiverTask.)
Public method Cleanup() () () ()
Removes individual receiver thunks attached to ports participating in the join
(Overrides ReceiverTask. . :: . .Cleanup() () () ().)
Public method Cleanup(ITask)
Returns messages instances attached to the task instance, to the appropriate ports participating in the join
(Overrides JoinReceiverTask. . :: . .Cleanup(ITask).)
Protected method Commit
Attempts to remove one item per port and complete the join
(Overrides JoinReceiverTask. . :: . .Commit() () () ().)
Public method Consume
Consume
(Overrides ReceiverTask. . :: . .Consume(IPortElement).)
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method Evaluate(IPortElement, ITask%)
Invoked in the context of Port.Post() to examine a message
(Overrides ReceiverTask. . :: . .Evaluate(IPortElement, ITask%).)
Public method Evaluate(ReceiverTask, ITask%)
Determines if a commit should be scheduled by checking if all items from ports are available
(Inherited from JoinReceiverTask.)
Public method Execute
Invoked by the scheduler to register the receiver on the ports.
(Inherited from ReceiverTask.)
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.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method PartialClone
Shallow clone of receiver state and task state
(Inherited from ReceiverTask.)
Protected method Register
Registers child receivers on each port in the join, so it can get notified when messages become available in the ports
(Overrides JoinReceiverTask. . :: . .Register() () () ().)
Protected method ShouldCommit
Checks if the ports participating in the join have one message each so it can schedule a Commit phase and attempt to retrieve the items
(Overrides JoinReceiverTask. . :: . .ShouldCommit() () () ().)
Public method ToString
Description of JoinReceiver state
(Overrides ReceiverTask. . :: . .ToString() () () ().)
Protected method UnrollPartialCommit
If the join commit fails for any reason this routine will post back any items taken from ports
(Overrides JoinReceiverTask. . :: . .UnrollPartialCommit(array

Properties

  Name Description
Public property Arbiter
Parent arbiter instance
(Inherited from JoinReceiverTask.)
Public property ArbiterCleanupHandler
Set by a top level arbiter so it can execute logic on task completion
(Inherited from TaskCommon.)
Public property ArbiterContext
Used by parent arbiter to store context
(Inherited from ReceiverTask.)
Public property ArbiterState
Arbiter state
(Inherited from JoinReceiverTask.)
Public property Item
Returns the arguments contained in the receiver
(Inherited from ReceiverTask.)
Public property LinkedIterator
Iterator that needs to be processed once current task completes
(Inherited from TaskCommon.)
Public property PortElementCount
Number of arguments this receiver is waiting on
(Inherited from ReceiverTask.)
Public property State
Receiver state
(Inherited from ReceiverTask.)
Public property TaskQueue
Dispatcher queue to use for scheduling any tasks
(Inherited from TaskCommon.)
Protected property UserTask
Task instance that contains the user delegate plus arguments.
(Inherited from ReceiverTask.)

See Also

JoinReceiver Class

Microsoft.Ccr.Core Namespace