Port(T) Methods

Article
02/27/2012

Microsoft Robotics Class Reference

The Port< (Of < ( <'T> ) > ) > type exposes the following members.

Methods

	Name	Description
	Clear	Clears all items from the port
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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	Application domain unique identity for this port instance. Guaranteed to be stable for the lifetime of the port instance (Overrides Object. . :: . .GetHashCode() () () ().)
	GetItems	All items currently queued. Items are not removed from the port
	GetReceivers	Array of all receivers associated with this port
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Post	Enqueues a message instance
	PostElement	Returns element at the beginning of FIFO
	PostUnknownType	Untyped post of an object.
	RegisterReceiver	Associates a receiver task with this port
	Test() () () ()	Atomically removes a message from the port, or returns null if none present
	Test(T%)	Atomically removes a message from the port, if port is non empty.
	TestForElement	Atomically removes a message container
	TestForMultipleElements	Atomically removes multiple message containers
	ToString	Provides a detailed description of the port state including registered receivers and their hierarchy (Overrides Object. . :: . .ToString() () () ().)
	TryPostUnknownType	Attempts unsafe (untyped) post of an object. Remarks Use to avoid possible exception thrown if item type is incompatible with the port
	UnregisterReceiver	Unregisters a receiver/arbiter from the port.

Extension Methods

	Name	Description
	Join< (Of < <' (T0> ) > > )(Int32, VariableArgumentHandler< (Of < <' (T0> ) > > ))	Overloaded. Creates a one time Join for multiple items from the same port instance (Defined by PortExtensions.)
	Join< (Of < <' (T0, T1> ) > > )(Port< (Of < <' (T1> ) > > ), Handler< (Of < <' (T0, T1> ) > > ))	Overloaded. Creates a one time Join across two ports (Defined by PortExtensions.)
	Join< (Of < <' (T0, T1, T2> ) > > )(Port< (Of < <' (T1> ) > > ), Port< (Of < <' (T2> ) > > ), Handler< (Of < <' (T0, T1, T2> ) > > ))	Overloaded. Creates a one time Join across two ports (Defined by PortExtensions.)
	Receive< (Of < <' (T> ) > > )() () () ()	Overloaded. Iterator use only. Creates a one time receiver that satisfies the yield operation and leaves the received item in the port (Defined by PortExtensions.)
	Receive< (Of < <' (T> ) > > )(Handler< (Of < <' (T> ) > > ))	Overloaded. Creates a one time receiver (Defined by PortExtensions.)
	Receive< (Of < <' (T> ) > > )(Handler< (Of < <' (T> ) > > ), Predicate< (Of < <' (T> ) > > ))	Overloaded. Creates a one time receiver (Defined by PortExtensions.)

See Also

Port< (Of < ( <'T> ) > ) > Class

Microsoft.Ccr.Core Namespace