Collapse All Expand All | Language Filter: C#Language Filter: Visual Basic Language Filter: Visual C++ C# Visual Basic Visual C++ | Members | See Also
StreamBase Client API
StreamBaseMonitor Class

Monitors a StreamBase Server, and gathers statistics. Periodically sends Snapshot objects to all registered MonitorListeners.

Namespace: StreamBase.SB.Monitor
Assembly: StreamBase.SB.Monitor (in StreamBase.SB.Monitor.dll) Version: 10.3.0.0

# Syntax

| C# |  |  | Visual Basic |  |  | Visual C++ |

    public class StreamBaseMonitor : IDisposable

    Public Class StreamBaseMonitor _
    	Implements IDisposable

    public ref class StreamBaseMonitor : IDisposable

# Members

| All Members |  |  | Constructors |  |  | Methods |

Public Protected | Instance Static | Declared Inherited | XNA Framework Only .NET Compact Framework Only |

| Member | Description
--- | --- | ---
| StreamBaseMonitor(String) | Create a monitoring object, which will connect to a server with the given StreamBaseURI. The connection will not be made until caller calls run(). A null StreamBaseURI will get the connection information from the STREAMBASE_SERVER environment variable, if set. The default server is "sb://localhost:10000".
| StreamBaseMonitor(StreamBaseURI) | Create a monitoring object, which will connect to a server with the given StreamBaseURI. The connection will not be made until caller calls run(). A null StreamBaseURI will get the connection information from the STREAMBASE_SERVER environment variable, if set. The default server is "sb://localhost:10000".
| StreamBaseMonitor(StreamBaseURI, String) | Constructor using an arbitrary stream name. The connection will not be made until caller calls run().
| AddMonitorListener(MonitorListener) | Add a listener for snapshot information. If the given listener has already been added just return. Listeners are called in the order in which they were added.
| Close()()()() | Close this monitor.
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (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.)
| RemoveMonitorListener(MonitorListener) | Remove a listener that was previously added.
| RemoveMonitorListeners()()()() | Remove all listeners.
| Run()()()() | Read and process monitor snapshots from sbd. This function will block, and will not return until Terminate is called or the connection to the StreamBase server is disconnected. Any call to Terminate must be either from inside a MonitorListener, or from another thread.
| Terminate()()()() | Ask the monitor to terminate. Termination will occur after the next snapshot, or after the current snapshot if Terminate() is invoked from within a MonitorListener's SnapshotReceived() method.
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.)

# Inheritance Hierarchy

System..::..Object
StreamBase.SB.Monitor..::..StreamBaseMonitor

# See Also

StreamBase.SB.Monitor Namespace