ConnectionStatusUpdate

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Add On > Connection >

ConnectionStatusUpdate

Previous page Return to chapter overview Next page

Definition

ConnectionStatusUpdate can be used for subscribing to connection status update events.

 

Note: Remember to unsubscribe if you are no longer using the subscription.

 

Syntax

ConnectionStatusUpdate

 

 

Example

ns


/* Example of subscribing/unsubscribing to execution update events from an Add On. The concept can be carried over
to any NinjaScript object you may be working on. */
public class MyAddOnTab : NTTabPage
{
    private Connection connection;
    public MyAddOnTab()
    {
        // Subscribe to execution updates
        Connection.ConnectionStatusUpdate += OnConnectionStatusUpdate;
    }
 
    // This method is fired on connection status update events
    private void OnConnectionStatusUpdate(object sender, ConnectionStatusEventArgs e)
    {
        /* For multi-threading reasons, work with a copy of the ConnectionStatusEventArgs to prevent situations
         where the ConnectionStatusEventArgs may already be ahead of us while in the middle processing it. */
        ConnectStatusEventArgs eCopy = e;
 
        // If the Kinetick EOD connection disconnects, do something
        if (eCopy.Connection.Options.Name == "Kinetick - End Of Day (Free)")
        {
              if (eCopy.Status == ConnectionStatus.Disconnected)
                  // Do something
        }
    }
 
    // Called by TabControl when tab is being removed or window is closed
    public override void Cleanup()
    {
        // Make sure to unsubscribe to the connection status subscription
        Connection.ConnectionStatusUpdate -= OnConnectionStatusUpdate;
    }
 
    // Other required NTTabPage members left out for demonstration purposes. Be sure to add them in your own code.
}