Vertex ClassNaiad Help

[This is preliminary documentation and is subject to change.]

Inheritance Hierarchy

SystemObject
  Microsoft.Research.Naiad.DataflowVertex
    Microsoft.Research.Naiad.DataflowVertexTTime

Namespace: Microsoft.Research.Naiad.Dataflow
Assembly: Microsoft.Research.Naiad (in Microsoft.Research.Naiad.dll) Version: 0.5.0.0 (0.5.0.0)
Syntax

C#
public abstract class Vertex

The Vertex type exposes the following members.

Methods

  NameDescription
Public methodAddOnFlushAction
Adds a Action to be called each time the vertex Flush method is called.
Protected methodCheckpoint
Writes the state of this vertex to the given writer.
Protected methodFlush
Flushes all buffered state at this vertex.
Protected methodOnShutdown
Called when the vertex is shut down
Protected methodRestore
Restores the state of this vertex from the given reader.
Public methodToString
Returns a string representation of this vertex.
(Overrides ObjectToString.)
Protected methodUpdateReachability
The worker will invoke this method periodically to indicate progress through the computation, and enable (for example) garbage-collection code to run.
Top
Fields

  NameDescription
Protected fieldisShutdown
Currently available for checkpoint restore
Public fieldStage
The stage to which this vertex belongs.
Public fieldVertexId
Vertex identifier (unique within the same Stage).
Top
Properties

  NameDescription
Protected propertyEntrancy
Indicates number of additional times the vertex may be entered
Public propertyIsShutDown
Indicates whether the vertex has been shut down
Public propertyLoggingOutput
The stream that will be used for logging updates to the vertex state.
Top
Remarks

This class provides common functionality to dataflow vertices that do not depend on a specific TimeTTime type. When implementing a new vertex for use in Naiad, use VertexTTime as the base class.
See Also

Reference