Package Products :: Package ZenStatus :: Module interfaces |
[hide private]
[frames] | no frames]

# Source Code for Module Products.ZenStatus.interfaces

     1  ##############################################################################
     2  #
     3  # Copyright (C) Zenoss, Inc. 2011, all rights reserved.
     4  #
     5  # This content is made available according to terms specified in
     6  # License.zenoss under the directory where your Zenoss product is installed.
     7  #
     8  ##############################################################################
     9
    10
    11  from Products.ZenCollector import interfaces
    12  from zope import interface
    13
    14 -class IPingTask(interfaces.IScheduledTask):
    15      """
    16      Task to perform process pings on an ip.
    17      """
    18
    19 -    def processPingResult(pingResult):
    20          """
    21              Process a ping result.
    22          """
    23          pass
    24
    25
    26 -class IPingTaskFactory(interfaces.IScheduledTaskFactory):
    27      """
    28      Factory to create PingTasks.
    29      """
    30      pass
    31
    32
    33 -class IPingCollectionPreferences(interfaces.ICollectorPreferences):
    34      """
    35      Class to customize app startup based on ping backend.
    36      """
    37      pass
    38
    39
    40 -class IPingResult(interface.Interface):
    41      """
    42      Class to store results from ping scan.
    43      """
    44
    45
    46      timestamp = interface.Attribute("""
    47          Timestamp of when ping was returned (seconds since epoch).
    48          """)
    49
    50      address = interface.Attribute("""
    51          Address of the host
    52          """)
    53
    54      trace = interface.Attribute("""
    55          traceroute of the host
    56          """)
    57
    58      getStatusString = interface.Attribute("""
    59          status string: up or down
    60          """)
    61
    62      isUp = interface.Attribute("""
    63          true if host is up, false if host is down
    64          """)
    65
    66      rtt = interface.Attribute("""
    67          round trip time aka ping time aka rtt; nan if host was down
    68          """)
    69
    70      variance = interface.Attribute("""
    71          variance of the rtt; nan if host was down
    72          """)
    73
    74      stdDeviation = interface.Attribute("""
    75          standard deviation of the rtt; nan if host was down
    76          """)
    77