MonitorMIDServer - Global

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read
  • The MonitorMIDServer script include provides methods to monitor MID Servers using the heartbeat probe to check for MID Servers that are down, sends heartbeat requests, and kills old heartbeat requests.

    Use this script include in a server script to monitor MID Servers.

    MonitorMIDServer - MonitorMIDServer()

    Creates an instance of MonitorMIDServer.

    Table 1. Parameters
    Name Type Description
    None

    MonitorMIDServer - killOldRequests()

    If there are any heartbeat probe requests that haven't been processed, cancels them so that they don't accumulate when a MID server is down for a while.

    Table 2. Parameters
    Name Type Description
    None
    Table 3. Returns
    Type Description
    void
    var mmsv = new MonitorMIDServer();
    mmsv.killOldRequests();

    MonitorMIDServer - markDowners()

    Marks any non-responding MID servers as being down, by determining when the most recent heartbeat was sent and finding all non-responding servers.

    Table 4. Parameters
    Name Type Description
    None
    Table 5. Returns
    Type Description
    void
    var mmsv = new MonitorMIDServer();
    mmsv.markDowners();

    MonitorMIDServer - monitor()

    Performs the functions required for a scheduled MID server monitor cycle, including killing old requests, marking the MID servers that are down, and sending heartbeat requests to all servers.

    Table 6. Parameters
    Name Type Description
    None
    Table 7. Returns
    Type Description
    void
    var mmsv = new MonitorMIDServer();
    mmsv.monitor();

    MonitorMIDServer - sendHeartbeatRequests()

    Sends heartbeat requests to all MID servers and notes when by updating the server status record.

    Table 8. Parameters
    Name Type Description
    None
    Table 9. Returns
    Type Description
    void
    var mmsv = new MonitorMIDServer();
    mmsv.sendHeartbeatRequests();