Interface SentinelSipUsage

  • All Superinterfaces:
    com.opencloud.sentinel.stats.SentinelCoreUsage, com.opencloud.rhino.facilities.usage.UsageParametersInterface

    public interface SentinelSipUsage
    extends com.opencloud.sentinel.stats.SentinelCoreUsage
    Usage statistics collected by the Sentinel Sip service.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void incrementAcks​(long delta)
      Incremented by Sentinel whenever an ack is received from a call party.
      void incrementActivityEndEvent​(long delta)
      Incremented by Sentinel when an ActivityEndEvent occurs.
      void incrementAnsweredCalls​(long delta)
      Incremented by Sentinel whenever a call is answered.
      void incrementByes​(long delta)
      Incremented by Sentinel whenever a bye is received from a call party.
      void incrementCancels​(long delta)
      Incremented by Sentinel whenever a cancel is received from a call party.
      void incrementCdrNotWritten​(long delta)
      Incremented by Sentinel when a CDR is not written.
      void incrementCdrWritten​(long delta)
      Incremented by Sentinel when a CDR is written.
      void incrementCompletedWithinCredit​(long delta)
      Incremented by Sentinel whenever a call is disconnected normally (completed within credit).
      void incrementError​(long delta)
      Incremented by Sentinel whenever an error event is received from a call party.
      void incrementFeatureTimeout​(long delta)
      Incremented by Sentinel whenever a feature timeout timer even is received.
      void incrementHttpDeletes​(long delta)
      Incremented by Sentinel whenever a HTTP DELETE request is received.
      void incrementHttpGets​(long delta)
      Incremented by Sentinel whenever a HTTP GET request is received for third party call setup.
      void incrementHttpHeads​(long delta)
      Incremented by Sentinel whenever a HTTP HEAD request is received.
      void incrementHttpPosts​(long delta)
      Incremented by Sentinel whenever a HTTP POST request is received for third party call setup.
      void incrementHttpPuts​(long delta)
      Incremented by Sentinel whenever a HTTP PUT request is received.
      void incrementIgnoredExtensionEventAtSessionEnd​(long delta)
      Incremented by Sentinel when an extension event is received, but session management is in the end state.
      void incrementInfo​(long delta)
      Incremented by Sentinel whenever an info event is received from a call party.
      void incrementInstructionExecutionFailure​(long delta)
      Incremented by Sentinel when an InstructionExecutionFailure occurs.
      void incrementInvites​(long delta)
      Incremented by Sentinel whenever an invite is received.
      void incrementMessage​(long delta)
      Incremented by Sentinel whenever a message event is received from a call party.
      void incrementNoAckReceived​(long delta)
      Incremented by Sentinel whenever a NoAckReceived is received.
      void incrementNoPrackReceived​(long delta)
      Incremented by Sentinel whenever a NoPrackReceived is received.
      void incrementNotify​(long delta)
      Incremented by Sentinel whenever a notify event is received from a call party.
      void incrementOptions​(long delta)
      Incremented by Sentinel whenever an options event is received from a call party.
      void incrementPeriodicWorkEvent​(long delta)
      Incremented by Sentinel when a periodic work event is received.
      void incrementPlatformConfigurationProfileNotFound​(long delta)
      Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so
      void incrementPlatformConfigurationTableNotFound​(long delta)
      Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so
      void incrementPrack​(long delta)
      Incremented by Sentinel whenever a prack event is received from a call party.
      void incrementProvisional​(long delta)
      Incremented by Sentinel whenever a provisional event is received from a call party.
      void incrementPublish​(long delta)
      Incremented by Sentinel whenever a publish event is received from a call party.
      void incrementRedirect​(long delta)
      Incremented by Sentinel whenever a redirect event is received from a call party.
      void incrementRefer​(long delta)
      Incremented by Sentinel whenever a refer event is received from a call party.
      void incrementRegister​(long delta)
      Incremented by Sentinel whenever a register event is received
      void incrementServiceCompleted​(long delta)
      Incremented by Sentinel whenever a session is released.
      void incrementServiceTimerEvent​(long delta)
      Incremented by Sentinel when a service timer event is received for execution point delivery.
      void incrementServiceTimerExtensionEvent​(long delta)
      Incremented by Sentinel when a service timer event is received for extension event delivery.
      void incrementServiceTriggered​(long delta)
      Incremented by Sentinel whenever a call of any type is attempted.
      void incrementSubscribe​(long delta)
      Incremented by Sentinel whenever a subscribe event is received from a call party.
      void incrementSuccess​(long delta)
      Incremented by Sentinel whenever a success event is received from a call party.
      void incrementUnknownTimer​(long delta)
      Incremented by Sentinel whenever an unknown timer event is dropped.
      void incrementUpdate​(long delta)
      Incremented by Sentinel whenever an update event is received from a call party.
      • Methods inherited from interface com.opencloud.sentinel.stats.SentinelCoreUsage

        incrementAbortSessionLocalAnswer, incrementCompletedOnExhaustingCredit, incrementCreditControlFailure, incrementCreditControlNotApplicable, incrementEndedByCCFailure, incrementInsufficientCredit, incrementReAuthLocalAnswer, incrementReAuthRequest, incrementTccExpiry, incrementValidityTimeExpiry
      • Methods inherited from interface com.opencloud.rhino.facilities.usage.UsageParametersInterface

        children, getOrCreateChild, getOrCreateChild, hasChild, key, name, parent, remove, type
    • Method Detail

      • incrementServiceTriggered

        @UsageCounter(mapping=100,
                      description="Incremented by Sentinel whenever a call of any type is attempted.",
                      shortName="",
                      unitLabel="")
        void incrementServiceTriggered​(long delta)
        Incremented by Sentinel whenever a call of any type is attempted.
        Parameters:
        delta - the increment
      • incrementServiceCompleted

        @UsageCounter(mapping=101,
                      description="Incremented by Sentinel whenever a session is released.",
                      shortName="",
                      unitLabel="")
        void incrementServiceCompleted​(long delta)
        Incremented by Sentinel whenever a session is released.
        Parameters:
        delta - the increment
      • incrementHttpDeletes

        @UsageCounter(mapping=102,
                      description="Incremented by Sentinel whenever a HTTP DELETE request is received.",
                      shortName="",
                      unitLabel="")
        void incrementHttpDeletes​(long delta)
        Incremented by Sentinel whenever a HTTP DELETE request is received.
        Parameters:
        delta - the increment
      • incrementHttpGets

        @UsageCounter(mapping=103,
                      description="Incremented by Sentinel whenever a HTTP GET request is received for third party call setup.",
                      shortName="",
                      unitLabel="")
        void incrementHttpGets​(long delta)
        Incremented by Sentinel whenever a HTTP GET request is received for third party call setup.
        Parameters:
        delta - the increment
      • incrementHttpHeads

        @UsageCounter(mapping=104,
                      description="Incremented by Sentinel whenever a HTTP HEAD request is received.",
                      shortName="",
                      unitLabel="")
        void incrementHttpHeads​(long delta)
        Incremented by Sentinel whenever a HTTP HEAD request is received.
        Parameters:
        delta - the increment
      • incrementHttpPosts

        @UsageCounter(mapping=105,
                      description="Incremented by Sentinel whenever a HTTP POST request is received for third party call setup.",
                      shortName="",
                      unitLabel="")
        void incrementHttpPosts​(long delta)
        Incremented by Sentinel whenever a HTTP POST request is received for third party call setup.
        Parameters:
        delta - the increment
      • incrementHttpPuts

        @UsageCounter(mapping=106,
                      description="Incremented by Sentinel whenever a HTTP PUT request is received.",
                      shortName="",
                      unitLabel="")
        void incrementHttpPuts​(long delta)
        Incremented by Sentinel whenever a HTTP PUT request is received.
        Parameters:
        delta - the increment
      • incrementInvites

        @UsageCounter(mapping=107,
                      description="Incremented by Sentinel whenever an invite is received.",
                      shortName="",
                      unitLabel="")
        void incrementInvites​(long delta)
        Incremented by Sentinel whenever an invite is received.
        Parameters:
        delta - the increment
      • incrementAcks

        @UsageCounter(mapping=108,
                      description="Incremented by Sentinel whenever an ack is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementAcks​(long delta)
        Incremented by Sentinel whenever an ack is received from a call party.
        Parameters:
        delta - the increment
      • incrementByes

        @UsageCounter(mapping=109,
                      description="Incremented by Sentinel whenever a bye is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementByes​(long delta)
        Incremented by Sentinel whenever a bye is received from a call party.
        Parameters:
        delta - the increment
      • incrementCancels

        @UsageCounter(mapping=110,
                      description="Incremented by Sentinel whenever a cancel is received from a call party. during initial call setup.",
                      shortName="",
                      unitLabel="")
        void incrementCancels​(long delta)
        Incremented by Sentinel whenever a cancel is received from a call party. during initial call setup.
        Parameters:
        delta - the increment
      • incrementInfo

        @UsageCounter(mapping=111,
                      description="Incremented by Sentinel whenever an info event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementInfo​(long delta)
        Incremented by Sentinel whenever an info event is received from a call party.
        Parameters:
        delta - the increment
      • incrementPrack

        @UsageCounter(mapping=112,
                      description="Incremented by Sentinel whenever a prack event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementPrack​(long delta)
        Incremented by Sentinel whenever a prack event is received from a call party.
        Parameters:
        delta - the increment
      • incrementUpdate

        @UsageCounter(mapping=113,
                      description="Incremented by Sentinel whenever an update event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementUpdate​(long delta)
        Incremented by Sentinel whenever an update event is received from a call party.
        Parameters:
        delta - the increment
      • incrementNotify

        @UsageCounter(mapping=114,
                      description="Incremented by Sentinel whenever a notify event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementNotify​(long delta)
        Incremented by Sentinel whenever a notify event is received from a call party.
        Parameters:
        delta - the increment
      • incrementMessage

        @UsageCounter(mapping=115,
                      description="Incremented by Sentinel whenever a message event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementMessage​(long delta)
        Incremented by Sentinel whenever a message event is received from a call party.
        Parameters:
        delta - the increment
      • incrementSubscribe

        @UsageCounter(mapping=116,
                      description="Incremented by Sentinel whenever a subscribe event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementSubscribe​(long delta)
        Incremented by Sentinel whenever a subscribe event is received from a call party.
        Parameters:
        delta - the increment
      • incrementOptions

        @UsageCounter(mapping=117,
                      description="Incremented by Sentinel whenever an options event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementOptions​(long delta)
        Incremented by Sentinel whenever an options event is received from a call party.
        Parameters:
        delta - the increment
      • incrementRefer

        @UsageCounter(mapping=118,
                      description="Incremented by Sentinel whenever a refer event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementRefer​(long delta)
        Incremented by Sentinel whenever a refer event is received from a call party.
        Parameters:
        delta - the increment
      • incrementRegister

        @UsageCounter(mapping=119,
                      description="Incremented by Sentinel whenever a register event is received",
                      shortName="",
                      unitLabel="")
        void incrementRegister​(long delta)
        Incremented by Sentinel whenever a register event is received
        Parameters:
        delta - the increment
      • incrementPublish

        @UsageCounter(mapping=120,
                      description="Incremented by Sentinel whenever a publish event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementPublish​(long delta)
        Incremented by Sentinel whenever a publish event is received from a call party.
        Parameters:
        delta - the increment
      • incrementSuccess

        @UsageCounter(mapping=121,
                      description="Incremented by Sentinel whenever a success event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementSuccess​(long delta)
        Incremented by Sentinel whenever a success event is received from a call party.
        Parameters:
        delta - the increment
      • incrementError

        @UsageCounter(mapping=122,
                      description="Incremented by Sentinel whenever an error event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementError​(long delta)
        Incremented by Sentinel whenever an error event is received from a call party.
        Parameters:
        delta - the increment
      • incrementRedirect

        @UsageCounter(mapping=123,
                      description="Incremented by Sentinel whenever a redirect event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementRedirect​(long delta)
        Incremented by Sentinel whenever a redirect event is received from a call party.
        Parameters:
        delta - the increment
      • incrementProvisional

        @UsageCounter(mapping=124,
                      description="Incremented by Sentinel whenever a provisional event is received from a call party.",
                      shortName="",
                      unitLabel="")
        void incrementProvisional​(long delta)
        Incremented by Sentinel whenever a provisional event is received from a call party.
        Parameters:
        delta - the increment
      • incrementAnsweredCalls

        @UsageCounter(mapping=125,
                      description="Incremented by Sentinel whenever a call is answered.",
                      shortName="",
                      unitLabel="")
        void incrementAnsweredCalls​(long delta)
        Incremented by Sentinel whenever a call is answered.
        Parameters:
        delta - the increment
      • incrementNoAckReceived

        @UsageCounter(mapping=126,
                      description="Incremented by Sentinel whenever a NoAckReceived is received.",
                      shortName="",
                      unitLabel="")
        void incrementNoAckReceived​(long delta)
        Incremented by Sentinel whenever a NoAckReceived is received.
        Parameters:
        delta - the increment
      • incrementNoPrackReceived

        @UsageCounter(mapping=127,
                      description="Incremented by Sentinel whenever a NoPrackReceived is received.",
                      shortName="",
                      unitLabel="")
        void incrementNoPrackReceived​(long delta)
        Incremented by Sentinel whenever a NoPrackReceived is received.
        Parameters:
        delta - the increment
      • incrementCompletedWithinCredit

        @UsageCounter(mapping=128,
                      description="Incremented by Sentinel whenever a call is disconnected normally (completed within credit).",
                      shortName="",
                      unitLabel="")
        void incrementCompletedWithinCredit​(long delta)
        Incremented by Sentinel whenever a call is disconnected normally (completed within credit).
        Parameters:
        delta - the increment
      • incrementCdrWritten

        @UsageCounter(mapping=129,
                      description="Incremented by Sentinel when a CDR is written.",
                      shortName="",
                      unitLabel="")
        void incrementCdrWritten​(long delta)
        Incremented by Sentinel when a CDR is written.
        Parameters:
        delta -
      • incrementCdrNotWritten

        @UsageCounter(mapping=130,
                      description="Incremented by Sentinel when a CDR is not written.",
                      shortName="",
                      unitLabel="")
        void incrementCdrNotWritten​(long delta)
        Incremented by Sentinel when a CDR is not written.
        Parameters:
        delta -
      • incrementActivityEndEvent

        @UsageCounter(mapping=131,
                      description="Incremented by Sentinel when an ActivityEndEvent occurs.",
                      shortName="",
                      unitLabel="")
        void incrementActivityEndEvent​(long delta)
        Incremented by Sentinel when an ActivityEndEvent occurs.
        Parameters:
        delta -
      • incrementInstructionExecutionFailure

        @UsageCounter(mapping=132,
                      description="Incremented by Sentinel when an InstructionExecutionFailure occurs.",
                      shortName="",
                      unitLabel="")
        void incrementInstructionExecutionFailure​(long delta)
        Incremented by Sentinel when an InstructionExecutionFailure occurs.
        Parameters:
        delta -
      • incrementIgnoredExtensionEventAtSessionEnd

        @UsageCounter(mapping=133,
                      description="Incremented by Sentinel when an extension event is received, but session management is in the end state.",
                      shortName="",
                      unitLabel="")
        void incrementIgnoredExtensionEventAtSessionEnd​(long delta)
        Incremented by Sentinel when an extension event is received, but session management is in the end state.
        Parameters:
        delta -
      • incrementServiceTimerEvent

        @UsageCounter(mapping=134,
                      description="Incremented by Sentinel when a service timer event is received for execution point delivery.",
                      shortName="",
                      unitLabel="")
        void incrementServiceTimerEvent​(long delta)
        Incremented by Sentinel when a service timer event is received for execution point delivery.
        Parameters:
        delta -
      • incrementServiceTimerExtensionEvent

        @UsageCounter(mapping=135,
                      description="Incremented by Sentinel when a service timer event is received for extension event delivery.",
                      shortName="",
                      unitLabel="")
        void incrementServiceTimerExtensionEvent​(long delta)
        Incremented by Sentinel when a service timer event is received for extension event delivery.
        Parameters:
        delta -
      • incrementFeatureTimeout

        @UsageCounter(mapping=136,
                      description="Incremented by Sentinel whenever a feature timeout timer even is received.",
                      shortName="",
                      unitLabel="")
        void incrementFeatureTimeout​(long delta)
        Incremented by Sentinel whenever a feature timeout timer even is received.
        Parameters:
        delta -
      • incrementUnknownTimer

        @UsageCounter(mapping=137,
                      description="Incremented by Sentinel whenever an unknown timer event is dropped.",
                      shortName="",
                      unitLabel="")
        void incrementUnknownTimer​(long delta)
        Incremented by Sentinel whenever an unknown timer event is dropped.
        Parameters:
        delta -
      • incrementPlatformConfigurationProfileNotFound

        @UsageCounter(mapping=138,
                      description="Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so",
                      shortName="",
                      unitLabel="")
        void incrementPlatformConfigurationProfileNotFound​(long delta)
        Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so
        Parameters:
        delta - the increment
      • incrementPlatformConfigurationTableNotFound

        @UsageCounter(mapping=139,
                      description="Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so",
                      shortName="",
                      unitLabel="")
        void incrementPlatformConfigurationTableNotFound​(long delta)
        Incremented by Sentinel whenever it tries to access platform level configuration, but cannot do so
        Parameters:
        delta - the increment
      • incrementPeriodicWorkEvent

        @UsageCounter(mapping=140,
                      description="Incremented by Sentinel when a periodic work event is received.",
                      shortName="",
                      unitLabel="")
        void incrementPeriodicWorkEvent​(long delta)
        Incremented by Sentinel when a periodic work event is received.
        Parameters:
        delta -